package
1.99.1
Repository: https://github.com/pendo-io/aws-sdk-go.git
Documentation: pkg.go.dev

# Packages

Package s3crypto provides encryption to S3 using KMS and AES GCM.
Package s3iface provides an interface to enable mocking the Amazon Simple Storage Service service client for testing your code.
Package s3manager provides utilities to upload and download objects from S3 concurrently.

# Functions

New creates a new instance of the S3 client with a session.
NormalizeBucketLocation is a utility function which will update the passed in value to always be a region ID.
WithNormalizeBucketLocation is a request option which will update the GetBucketLocation's result LocationConstraint value to always be a region ID.

# Constants

AnalyticsS3ExportFileFormatCsv is a AnalyticsS3ExportFileFormat enum value.
BucketAccelerateStatusEnabled is a BucketAccelerateStatus enum value.
BucketAccelerateStatusSuspended is a BucketAccelerateStatus enum value.
BucketCannedACLAuthenticatedRead is a BucketCannedACL enum value.
BucketCannedACLPrivate is a BucketCannedACL enum value.
BucketCannedACLPublicRead is a BucketCannedACL enum value.
BucketCannedACLPublicReadWrite is a BucketCannedACL enum value.
BucketLocationConstraintApNortheast1 is a BucketLocationConstraint enum value.
BucketLocationConstraintApSouth1 is a BucketLocationConstraint enum value.
BucketLocationConstraintApSoutheast1 is a BucketLocationConstraint enum value.
BucketLocationConstraintApSoutheast2 is a BucketLocationConstraint enum value.
BucketLocationConstraintCnNorth1 is a BucketLocationConstraint enum value.
BucketLocationConstraintEu is a BucketLocationConstraint enum value.
BucketLocationConstraintEuCentral1 is a BucketLocationConstraint enum value.
BucketLocationConstraintEuWest1 is a BucketLocationConstraint enum value.
BucketLocationConstraintSaEast1 is a BucketLocationConstraint enum value.
BucketLocationConstraintUsWest1 is a BucketLocationConstraint enum value.
BucketLocationConstraintUsWest2 is a BucketLocationConstraint enum value.
BucketLogsPermissionFullControl is a BucketLogsPermission enum value.
BucketLogsPermissionRead is a BucketLogsPermission enum value.
BucketLogsPermissionWrite is a BucketLogsPermission enum value.
BucketVersioningStatusEnabled is a BucketVersioningStatus enum value.
BucketVersioningStatusSuspended is a BucketVersioningStatus enum value.
CompressionTypeBzip2 is a CompressionType enum value.
CompressionTypeGzip is a CompressionType enum value.
CompressionTypeNone is a CompressionType enum value.
DeleteMarkerReplicationStatusDisabled is a DeleteMarkerReplicationStatus enum value.
DeleteMarkerReplicationStatusEnabled is a DeleteMarkerReplicationStatus enum value.
EncodingTypeUrl is a EncodingType enum value.
ID to lookup a service endpoint with.
ErrCodeBucketAlreadyExists for service response error code "BucketAlreadyExists".
ErrCodeBucketAlreadyOwnedByYou for service response error code "BucketAlreadyOwnedByYou".
ErrCodeNoSuchBucket for service response error code "NoSuchBucket".
ErrCodeNoSuchKey for service response error code "NoSuchKey".
ErrCodeNoSuchUpload for service response error code "NoSuchUpload".
ErrCodeObjectAlreadyInActiveTierError for service response error code "ObjectAlreadyInActiveTierError".
ErrCodeObjectNotInActiveTierError for service response error code "ObjectNotInActiveTierError".
EventS3ObjectCreated is a Event enum value.
EventS3ObjectCreatedCompleteMultipartUpload is a Event enum value.
EventS3ObjectCreatedCopy is a Event enum value.
EventS3ObjectCreatedPost is a Event enum value.
EventS3ObjectCreatedPut is a Event enum value.
EventS3ObjectRemoved is a Event enum value.
EventS3ObjectRemovedDelete is a Event enum value.
EventS3ObjectRemovedDeleteMarkerCreated is a Event enum value.
EventS3ObjectRestoreCompleted is a Event enum value.
EventS3ObjectRestorePost is a Event enum value.
EventS3ReducedRedundancyLostObject is a Event enum value.
ExpirationStatusDisabled is a ExpirationStatus enum value.
ExpirationStatusEnabled is a ExpirationStatus enum value.
ExpressionTypeSql is a ExpressionType enum value.
FileHeaderInfoIgnore is a FileHeaderInfo enum value.
FileHeaderInfoNone is a FileHeaderInfo enum value.
FileHeaderInfoUse is a FileHeaderInfo enum value.
FilterRuleNamePrefix is a FilterRuleName enum value.
FilterRuleNameSuffix is a FilterRuleName enum value.
InventoryFormatCsv is a InventoryFormat enum value.
InventoryFormatOrc is a InventoryFormat enum value.
InventoryFormatParquet is a InventoryFormat enum value.
InventoryFrequencyDaily is a InventoryFrequency enum value.
InventoryFrequencyWeekly is a InventoryFrequency enum value.
InventoryIncludedObjectVersionsAll is a InventoryIncludedObjectVersions enum value.
InventoryIncludedObjectVersionsCurrent is a InventoryIncludedObjectVersions enum value.
InventoryOptionalFieldEncryptionStatus is a InventoryOptionalField enum value.
InventoryOptionalFieldEtag is a InventoryOptionalField enum value.
InventoryOptionalFieldIsMultipartUploaded is a InventoryOptionalField enum value.
InventoryOptionalFieldLastModifiedDate is a InventoryOptionalField enum value.
InventoryOptionalFieldObjectLockLegalHoldStatus is a InventoryOptionalField enum value.
InventoryOptionalFieldObjectLockMode is a InventoryOptionalField enum value.
InventoryOptionalFieldObjectLockRetainUntilDate is a InventoryOptionalField enum value.
InventoryOptionalFieldReplicationStatus is a InventoryOptionalField enum value.
InventoryOptionalFieldSize is a InventoryOptionalField enum value.
InventoryOptionalFieldStorageClass is a InventoryOptionalField enum value.
JSONTypeDocument is a JSONType enum value.
JSONTypeLines is a JSONType enum value.
MetadataDirectiveCopy is a MetadataDirective enum value.
MetadataDirectiveReplace is a MetadataDirective enum value.
MFADeleteDisabled is a MFADelete enum value.
MFADeleteEnabled is a MFADelete enum value.
MFADeleteStatusDisabled is a MFADeleteStatus enum value.
MFADeleteStatusEnabled is a MFADeleteStatus enum value.
ObjectCannedACLAuthenticatedRead is a ObjectCannedACL enum value.
ObjectCannedACLAwsExecRead is a ObjectCannedACL enum value.
ObjectCannedACLBucketOwnerFullControl is a ObjectCannedACL enum value.
ObjectCannedACLBucketOwnerRead is a ObjectCannedACL enum value.
ObjectCannedACLPrivate is a ObjectCannedACL enum value.
ObjectCannedACLPublicRead is a ObjectCannedACL enum value.
ObjectCannedACLPublicReadWrite is a ObjectCannedACL enum value.
ObjectLockEnabledEnabled is a ObjectLockEnabled enum value.
ObjectLockLegalHoldStatusOff is a ObjectLockLegalHoldStatus enum value.
ObjectLockLegalHoldStatusOn is a ObjectLockLegalHoldStatus enum value.
ObjectLockModeCompliance is a ObjectLockMode enum value.
ObjectLockModeGovernance is a ObjectLockMode enum value.
ObjectLockRetentionModeCompliance is a ObjectLockRetentionMode enum value.
ObjectLockRetentionModeGovernance is a ObjectLockRetentionMode enum value.
ObjectStorageClassDeepArchive is a ObjectStorageClass enum value.
ObjectStorageClassGlacier is a ObjectStorageClass enum value.
ObjectStorageClassIntelligentTiering is a ObjectStorageClass enum value.
ObjectStorageClassOnezoneIa is a ObjectStorageClass enum value.
ObjectStorageClassReducedRedundancy is a ObjectStorageClass enum value.
ObjectStorageClassStandard is a ObjectStorageClass enum value.
ObjectStorageClassStandardIa is a ObjectStorageClass enum value.
ObjectVersionStorageClassStandard is a ObjectVersionStorageClass enum value.
OwnerOverrideDestination is a OwnerOverride enum value.
PayerBucketOwner is a Payer enum value.
PayerRequester is a Payer enum value.
PermissionFullControl is a Permission enum value.
PermissionRead is a Permission enum value.
PermissionReadAcp is a Permission enum value.
PermissionWrite is a Permission enum value.
PermissionWriteAcp is a Permission enum value.
ProtocolHttp is a Protocol enum value.
ProtocolHttps is a Protocol enum value.
QuoteFieldsAlways is a QuoteFields enum value.
QuoteFieldsAsneeded is a QuoteFields enum value.
ReplicationRuleStatusDisabled is a ReplicationRuleStatus enum value.
ReplicationRuleStatusEnabled is a ReplicationRuleStatus enum value.
ReplicationStatusComplete is a ReplicationStatus enum value.
ReplicationStatusFailed is a ReplicationStatus enum value.
ReplicationStatusPending is a ReplicationStatus enum value.
ReplicationStatusReplica is a ReplicationStatus enum value.
RequestChargedRequester is a RequestCharged enum value.
RequestPayerRequester is a RequestPayer enum value.
RestoreRequestTypeSelect is a RestoreRequestType enum value.
ServerSideEncryptionAes256 is a ServerSideEncryption enum value.
ServerSideEncryptionAwsKms is a ServerSideEncryption enum value.
ServiceID is a unique identifer of a specific service.
Name of service.
SseKmsEncryptedObjectsStatusDisabled is a SseKmsEncryptedObjectsStatus enum value.
SseKmsEncryptedObjectsStatusEnabled is a SseKmsEncryptedObjectsStatus enum value.
StorageClassAnalysisSchemaVersionV1 is a StorageClassAnalysisSchemaVersion enum value.
StorageClassDeepArchive is a StorageClass enum value.
StorageClassGlacier is a StorageClass enum value.
StorageClassIntelligentTiering is a StorageClass enum value.
StorageClassOnezoneIa is a StorageClass enum value.
StorageClassReducedRedundancy is a StorageClass enum value.
StorageClassStandard is a StorageClass enum value.
StorageClassStandardIa is a StorageClass enum value.
TaggingDirectiveCopy is a TaggingDirective enum value.
TaggingDirectiveReplace is a TaggingDirective enum value.
TierBulk is a Tier enum value.
TierExpedited is a Tier enum value.
TierStandard is a Tier enum value.
TransitionStorageClassDeepArchive is a TransitionStorageClass enum value.
TransitionStorageClassGlacier is a TransitionStorageClass enum value.
TransitionStorageClassIntelligentTiering is a TransitionStorageClass enum value.
TransitionStorageClassOnezoneIa is a TransitionStorageClass enum value.
TransitionStorageClassStandardIa is a TransitionStorageClass enum value.
TypeAmazonCustomerByEmail is a Type enum value.
TypeCanonicalUser is a Type enum value.
TypeGroup is a Type enum value.

# Variables

NormalizeBucketLocationHandler is a request handler which will update the GetBucketLocation's result LocationConstraint value to always be a region ID.

# Structs

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.
No description provided by the author
No description provided by the author
Configures the transfer acceleration state for an Amazon S3 bucket.
Contains the elements that set the ACL permissions for an object per grantee.
A container for information about access control for replicas.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
Where to publish the analytics results.
No description provided by the author
No description provided by the author
No description provided by the author
Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies a condition that must be met for a redirect to apply.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
Specifies a cross-origin access rule for an Amazon S3 bucket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes how a CSV-formatted input object is formatted.
Describes how CSV-formatted results are formatted.
The container element for specifying the default object lock retention settings for new objects placed in the specified bucket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies whether Amazon S3 should replicate delete makers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.
Describes the server-side encryption that will be applied to the restore results.
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
No description provided by the author
No description provided by the author
No description provided by the author
Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes the serialization format of the object.
Specifies the inventory configuration for an Amazon S3 bucket.
No description provided by the author
Contains the type of server-side encryption used to encrypt the inventory results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A container for object key name prefix and suffix filtering rules.
A container for specifying the configuration for AWS Lambda notifications.
No description provided by the author
No description provided by the author
No description provided by the author
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates.
The Filter is used to identify objects that a Lifecycle Rule applies to.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes an S3 location that will receive the results of the restore request.
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.
A metadata key-value pair to store with an object.
No description provided by the author
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
No description provided by the author
No description provided by the author
Specifies when noncurrent object versions expire.
Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class.
A container for specifying the notification configuration of the bucket.
No description provided by the author
Specifies object key name filtering rules.
No description provided by the author
No description provided by the author
The container element for object lock configuration parameters.
A Legal Hold configuration for an object.
A Retention configuration for an object.
The container element for an object lock rule.
No description provided by the author
Describes the location where the restore job's output is stored.
Describes how results of the Select job are serialized.
No description provided by the author
No description provided by the author
No description provided by the author
The container element for a bucket's policy status.
No description provided by the author
No description provided by the author
Specifies the Block Public Access configuration for an Amazon S3 bucket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
No description provided by the author
No description provided by the author
Specifies how requests are redirected.
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
A container for replication rules.
Specifies which Amazon S3 objects to replicate and where to store the replicas.
No description provided by the author
A filter that identifies the subset of objects to which the replication rule applies.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Container for restore job parameters.
Specifies the redirect behavior and when a redirect is applied.
Specifies lifecycle rules for an Amazon S3 bucket.
S3 provides the API operation methods for making requests to Amazon Simple Storage Service.
SelectObjectContentEventStream provides handling of EventStreams for the SelectObjectContent API.
Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement.
No description provided by the author
Describes the parameters for Select job types.
Describes the default server-side encryption to apply to new objects in the bucket.
Specifies the default server-side-encryption configuration.
Specifies the default server-side encryption configuration.
A container that describes additional filters for identifying the source objects that you want to replicate.
Specifies the use of SSE-KMS to encrypt delivered Inventory reports.
A container for filter information for the selection of S3 objects encrypted with AWS KMS.
Specifies the use of SSE-S3 to encrypt delivered Inventory reports.
No description provided by the author
No description provided by the author
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
No description provided by the author
Specifies when an object transitions to a specified storage class.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes the versioning state of an Amazon S3 bucket.
Specifies website configuration parameters for an Amazon S3 bucket.

# Interfaces

A RequestFailure provides access to the S3 Request ID and Host ID values returned from API operation errors.
SelectObjectContentEventStreamEvent groups together all EventStream events read from the SelectObjectContent API.
SelectObjectContentEventStreamReader provides the interface for reading EventStream Events from the SelectObjectContent API.