type AccessControlPolicy struct {
Grants []Grant
Owner *Owner
}
Contains the elements that set the ACL permissions for an object per grantee.
A container for information about access control for replicas.
type AnalyticsAndOperator ¶type AnalyticsAndOperator struct {
Prefix *string
Tags []Tag
}
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
Where to publish the analytics results.
type AnalyticsFilter interface {
}
The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
The following types satisfy this interface:
AnalyticsFilterMemberAnd AnalyticsFilterMemberPrefix AnalyticsFilterMemberTag
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
)
func main() {
var union types.AnalyticsFilter
// type switches can be used to check the union value
switch v := union.(type) {
case *types.AnalyticsFilterMemberAnd:
_ = v.Value // Value is types.AnalyticsAndOperator
case *types.AnalyticsFilterMemberPrefix:
_ = v.Value // Value is string
case *types.AnalyticsFilterMemberTag:
_ = v.Value // Value is types.Tag
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type AnalyticsFilterMemberAnd ¶ added in v0.31.0
A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.
type AnalyticsFilterMemberPrefix struct {
Value string
}
The prefix to use when evaluating an analytics filter.
type AnalyticsFilterMemberTag struct {
Value Tag
}
The tag to use when evaluating an analytics filter.
Contains information about where to publish the analytics results.
type AnalyticsS3ExportFileFormat string
Enum values for AnalyticsS3ExportFileFormat
Values returns all known values for AnalyticsS3ExportFileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
const ( ArchiveStatusArchiveAccess ArchiveStatus = "ARCHIVE_ACCESS" ArchiveStatusDeepArchiveAccess ArchiveStatus = "DEEP_ARCHIVE_ACCESS" )
Enum values for ArchiveStatus
Values returns all known values for ArchiveStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
In terms of implementation, a Bucket is a resource.
type BucketAccelerateStatus string
Enum values for BucketAccelerateStatus
Values returns all known values for BucketAccelerateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type BucketAlreadyExists struct {
Message *string
ErrorCodeOverride *string
}
The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.
type BucketAlreadyOwnedByYou struct {
Message *string
ErrorCodeOverride *string
}
The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
Enum values for BucketCannedACL
Values returns all known values for BucketCannedACL. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Specifies the information about the bucket that will be created. For more information about directory buckets, see Directory bucketsin the Amazon S3 User Guide.
This functionality is only supported by directory buckets.
type BucketLifecycleConfiguration struct {
Rules []LifecycleRule
}
Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Managementin the Amazon S3 User Guide.
type BucketLocationConstraint string
Enum values for BucketLocationConstraint
Values returns all known values for BucketLocationConstraint. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Container for logging status information.
type BucketLogsPermission string
Enum values for BucketLogsPermission
Values returns all known values for BucketLogsPermission. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
const ( BucketTypeDirectory BucketType = "Directory" )
Enum values for BucketType
Values returns all known values for BucketType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type BucketVersioningStatus string
Enum values for BucketVersioningStatus
Values returns all known values for BucketVersioningStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CORSConfiguration struct {
CORSRules []CORSRule
}
Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharingin the Amazon S3 User Guide.
Specifies a cross-origin access rule for an Amazon S3 bucket.
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
Contains all the possible checksum or digest values for an object.
Enum values for ChecksumAlgorithm
Values returns all known values for ChecksumAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ChecksumMode
Values returns all known values for ChecksumMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ChecksumType
Values returns all known values for ChecksumType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CommonPrefix struct {
Prefix *string
}
Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.
The container for the completed multipart upload details.
Details of the parts that were uploaded.
Enum values for CompressionType
Values returns all known values for CompressionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Condition struct {
HttpErrorCodeReturnedEquals *string
KeyPrefixEquals *string
}
A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
type ContinuationEvent struct {
}
Container for all response elements.
Container for all response elements.
The configuration information for the bucket.
const ( DataRedundancySingleAvailabilityZone DataRedundancy = "SingleAvailabilityZone" DataRedundancySingleLocalZone DataRedundancy = "SingleLocalZone" )
Enum values for DataRedundancy
Values returns all known values for DataRedundancy. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.
The DefaultRetention settings require both a mode and a period.
The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
Container for the objects to delete.
Information about the delete marker.
Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.
For more information about delete marker replication, see Basic Rule Configuration.
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
type DeleteMarkerReplicationStatus string
Enum values for DeleteMarkerReplicationStatus
Values returns all known values for DeleteMarkerReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Information about the deleted object.
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
The destination information for the S3 Metadata configuration.
Enum values for EncodingType
Values returns all known values for EncodingType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Contains the type of server-side encryption used.
type EncryptionConfiguration struct {
ReplicaKmsKeyID *string
}
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
type EncryptionTypeMismatch struct {
Message *string
ErrorCodeOverride *string
}
The existing object was created with a different encryption type. Subsequent
write requests must include the appropriate encryption parameters in the request or while creating the session.
A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent .
Container for all error elements.
type ErrorDetails struct {
ErrorCode *string
ErrorMessage *string
}
If an S3 Metadata V1 CreateBucketMetadataTableConfiguration or V2
CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfigurationso that you can expire journal table records and create a live inventory table.
type ErrorDocument struct {
Key *string
}
The error information.
const ( EventS3ReducedRedundancyLostObject Event = "s3:ReducedRedundancyLostObject" EventS3ObjectCreated Event = "s3:ObjectCreated:*" EventS3ObjectCreatedPut Event = "s3:ObjectCreated:Put" EventS3ObjectCreatedPost Event = "s3:ObjectCreated:Post" EventS3ObjectCreatedCopy Event = "s3:ObjectCreated:Copy" EventS3ObjectCreatedCompleteMultipartUpload Event = "s3:ObjectCreated:CompleteMultipartUpload" EventS3ObjectRemoved Event = "s3:ObjectRemoved:*" EventS3ObjectRemovedDelete Event = "s3:ObjectRemoved:Delete" EventS3ObjectRemovedDeleteMarkerCreated Event = "s3:ObjectRemoved:DeleteMarkerCreated" EventS3ObjectRestore Event = "s3:ObjectRestore:*" EventS3ObjectRestorePost Event = "s3:ObjectRestore:Post" EventS3ObjectRestoreCompleted Event = "s3:ObjectRestore:Completed" EventS3Replication Event = "s3:Replication:*" EventS3ReplicationOperationFailedReplication Event = "s3:Replication:OperationFailedReplication" EventS3ReplicationOperationNotTracked Event = "s3:Replication:OperationNotTracked" EventS3ReplicationOperationMissedThreshold Event = "s3:Replication:OperationMissedThreshold" EventS3ReplicationOperationReplicatedAfterThreshold Event = "s3:Replication:OperationReplicatedAfterThreshold" EventS3ObjectRestoreDelete Event = "s3:ObjectRestore:Delete" EventS3LifecycleTransition Event = "s3:LifecycleTransition" EventS3IntelligentTiering Event = "s3:IntelligentTiering" EventS3ObjectAclPut Event = "s3:ObjectAcl:Put" EventS3LifecycleExpiration Event = "s3:LifecycleExpiration:*" EventS3LifecycleExpirationDelete Event = "s3:LifecycleExpiration:Delete" EventS3LifecycleExpirationDeleteMarkerCreated Event = "s3:LifecycleExpiration:DeleteMarkerCreated" EventS3ObjectTagging Event = "s3:ObjectTagging:*" EventS3ObjectTaggingPut Event = "s3:ObjectTagging:Put" EventS3ObjectTaggingDelete Event = "s3:ObjectTagging:Delete" )
Enum values for Event
Values returns all known values for Event. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EventBridgeConfiguration struct {
}
A container for specifying the configuration for Amazon EventBridge.
type ExistingObjectReplicationStatus string
Enum values for ExistingObjectReplicationStatus
Values returns all known values for ExistingObjectReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ExpirationState
Values returns all known values for ExpirationState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ExpirationStatus
Values returns all known values for ExpirationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ExpressionType
Values returns all known values for ExpressionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for FileHeaderInfo
Values returns all known values for FileHeaderInfo. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/ . Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.
Enum values for FilterRuleName
Values returns all known values for FilterRuleName. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The S3 Metadata configuration for a general purpose bucket.
The V1 S3 Metadata configuration for a general purpose bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfigurationso that you can expire journal table records and create a live inventory table.
A collection of parts associated with a multipart upload.
type GlacierJobParameters struct {
Tier Tier
}
Container for S3 Glacier job parameters.
Container for grant information.
Container for the person being granted permissions.
type IdempotencyParameterMismatch struct {
Message *string
ErrorCodeOverride *string
}
Parameters on this idempotent request are inconsistent with parameters used in previous request(s).
For a list of error codes and more information on Amazon S3 errors, see Error codes.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
type IndexDocument struct {
Suffix *string
}
Container for the Suffix element.
Container element that identifies who initiated the multipart upload.
Describes the serialization format of the object.
type IntelligentTieringAccessTier string
Enum values for IntelligentTieringAccessTier
Values returns all known values for IntelligentTieringAccessTier. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type IntelligentTieringAndOperator ¶ added in v0.31.0type IntelligentTieringAndOperator struct {
Prefix *string
Tags []Tag
}
A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.
The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.
type IntelligentTieringStatus string
Enum values for IntelligentTieringStatus
Values returns all known values for IntelligentTieringStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Object is archived and inaccessible until restored.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objectsin the Amazon S3 User Guide.
type InvalidRequest struct {
Message *string
ErrorCodeOverride *string
}
You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:
Cannot specify both a write offset value and user-defined object metadata for existing objects.
Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.
Request body cannot be empty when 'write offset' is specified.
type InvalidWriteOffset struct {
Message *string
ErrorCodeOverride *string
}
The write offset value that you specified does not match the current object
size.
Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventoryin the Amazon S3 API Reference.
type InventoryConfigurationState string
Enum values for InventoryConfigurationState
Values returns all known values for InventoryConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Specifies the S3 Inventory configuration for an Amazon S3 bucket.
type InventoryEncryption struct {
SSEKMS *SSEKMS
SSES3 *SSES3
}
Contains the type of server-side encryption used to encrypt the S3 Inventory results.
type InventoryFilter struct {
Prefix *string
}
Specifies an S3 Inventory filter. The inventory only includes objects that meet the filter's criteria.
Enum values for InventoryFormat
Values returns all known values for InventoryFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InventoryFrequency string
Enum values for InventoryFrequency
Values returns all known values for InventoryFrequency. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InventoryIncludedObjectVersions string
Enum values for InventoryIncludedObjectVersions
Values returns all known values for InventoryIncludedObjectVersions. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InventoryOptionalField string
Enum values for InventoryOptionalField
Values returns all known values for InventoryOptionalField. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where S3 Inventory results are published.
Specifies the schedule for generating S3 Inventory results.
The inventory table configuration for an S3 Metadata configuration.
The inventory table configuration for an S3 Metadata configuration.
The specified updates to the S3 Metadata inventory table configuration.
Specifies JSON as object's input serialization format.
type JSONOutput struct {
RecordDelimiter *string
}
Specifies JSON as request's output serialization format.
const ( JSONTypeDocument JSONType = "DOCUMENT" JSONTypeLines JSONType = "LINES" )
Enum values for JSONType
Values returns all known values for JSONType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The journal table configuration for an S3 Metadata configuration.
The journal table configuration for the S3 Metadata configuration.
type JournalTableConfigurationUpdates struct {
RecordExpiration *RecordExpiration
}
The specified updates to the S3 Metadata journal table configuration.
A container for specifying the configuration for Lambda notifications.
type LifecycleExpiration struct {
Date *time.Time
Days *int32
ExpiredObjectDeleteMarker *bool
}
Container for the expiration for the lifecycle of the object.
For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.
type LifecycleRuleAndOperator ¶type LifecycleRuleAndOperator struct {
ObjectSizeGreaterThan *int64
ObjectSizeLessThan *int64
Prefix *string
Tags []Tag
}
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter can have exactly one of Prefix , Tag , ObjectSizeGreaterThan , ObjectSizeLessThan , or And specified. If the Filter element is left empty, the Lifecycle Rule applies to all objects in the bucket.
Specifies the location where the bucket will be created.
For directory buckets, the location type is Availability Zone or Local Zone. For more information about directory buckets, see Working with directory bucketsin the Amazon S3 User Guide.
This functionality is only supported by directory buckets.
const ( LocationTypeAvailabilityZone LocationType = "AvailabilityZone" LocationTypeLocalZone LocationType = "LocalZone" )
Enum values for LocationType
Values returns all known values for LocationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket loggingin the Amazon S3 API Reference.
Enum values for MFADelete
Values returns all known values for MFADelete. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for MFADeleteStatus
Values returns all known values for MFADeleteStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The S3 Metadata configuration for a general purpose bucket.
The S3 Metadata configuration for a general purpose bucket.
Enum values for MetadataDirective
Values returns all known values for MetadataDirective. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A metadata key-value pair to store with an object.
The V1 S3 Metadata configuration for a general purpose bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfigurationso that you can expire journal table records and create a live inventory table.
The V1 S3 Metadata configuration for a general purpose bucket. The destination
table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfigurationso that you can expire journal table records and create a live inventory table.
The encryption settings for an S3 Metadata journal table or inventory table
configuration.
A container specifying replication metrics-related settings enabling
replication metrics and events.
type MetricsAndOperator ¶type MetricsAndOperator struct {
AccessPointArn *string
Prefix *string
Tags []Tag
}
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.
type MetricsFilter interface {
}
Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
The following types satisfy this interface:
MetricsFilterMemberAccessPointArn MetricsFilterMemberAnd MetricsFilterMemberPrefix MetricsFilterMemberTag
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
)
func main() {
var union types.MetricsFilter
// type switches can be used to check the union value
switch v := union.(type) {
case *types.MetricsFilterMemberAccessPointArn:
_ = v.Value // Value is string
case *types.MetricsFilterMemberAnd:
_ = v.Value // Value is types.MetricsAndOperator
case *types.MetricsFilterMemberPrefix:
_ = v.Value // Value is string
case *types.MetricsFilterMemberTag:
_ = v.Value // Value is types.Tag
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type MetricsFilterMemberAccessPointArn struct {
Value string
}
The access point ARN used when evaluating a metrics filter.
type MetricsFilterMemberAnd ¶ added in v0.31.0A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
type MetricsFilterMemberPrefix struct {
Value string
}
The prefix used when evaluating a metrics filter.
type MetricsFilterMemberTag struct {
Value Tag
}
The tag used when evaluating a metrics filter.
Enum values for MetricsStatus
Values returns all known values for MetricsStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Container for the MultipartUpload for the Amazon S3 object.
type NoSuchBucket struct {
Message *string
ErrorCodeOverride *string
}
The specified bucket does not exist.
type NoSuchKey struct {
Message *string
ErrorCodeOverride *string
}
The specified key does not exist.
type NoSuchUpload struct {
Message *string
ErrorCodeOverride *string
}
The specified multipart upload does not exist.
type NoncurrentVersionExpiration struct {
NewerNoncurrentVersions *int32
NoncurrentDays *int32
}
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.
type NotFound struct {
Message *string
ErrorCodeOverride *string
}
The specified content does not exist.
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
An object consists of data and its descriptive metadata.
type ObjectAlreadyInActiveTierError struct {
Message *string
ErrorCodeOverride *string
}
This action is not allowed against this storage tier.
Enum values for ObjectAttributes
Values returns all known values for ObjectAttributes. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ObjectCannedACL
Values returns all known values for ObjectCannedACL. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Object Identifier is unique value to identify objects.
The container element for Object Lock configuration parameters.
Enum values for ObjectLockEnabled
Values returns all known values for ObjectLockEnabled. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A legal hold configuration for an object.
type ObjectLockLegalHoldStatus string
Enum values for ObjectLockLegalHoldStatus
Values returns all known values for ObjectLockLegalHoldStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ObjectLockMode
Values returns all known values for ObjectLockMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A Retention configuration for an object.
type ObjectLockRetentionMode string
Enum values for ObjectLockRetentionMode
Values returns all known values for ObjectLockRetentionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The container element for an Object Lock rule.
type ObjectNotInActiveTierError struct {
Message *string
ErrorCodeOverride *string
}
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
Enum values for ObjectOwnership
Values returns all known values for ObjectOwnership. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A container for elements related to an individual part.
type ObjectStorageClass string
Enum values for ObjectStorageClass
Values returns all known values for ObjectStorageClass. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The version of an object.
type ObjectVersionStorageClass string
Enum values for ObjectVersionStorageClass
Values returns all known values for ObjectVersionStorageClass. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OptionalObjectAttributes string
Enum values for OptionalObjectAttributes
Values returns all known values for OptionalObjectAttributes. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Describes the location where the restore job's output is stored.
Describes how results of the Select job are serialized.
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName . Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName .
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
Container for the owner's display name and ID.
Enum values for OwnerOverride
Values returns all known values for OwnerOverride. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The container element for a bucket's ownership controls.
The container element for an ownership control rule.
type ParquetInput struct {
}
Container for Parquet.
Container for elements related to a part.
type PartitionDateSource string
Enum values for PartitionDateSource
Values returns all known values for PartitionDateSource. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Amazon S3 keys for log objects are partitioned in the following format:
[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.
const ( PayerRequester Payer = "Requester" PayerBucketOwner Payer = "BucketOwner" )
Enum values for Payer
Values returns all known values for Payer. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for Permission
Values returns all known values for Permission. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PolicyStatus struct {
IsPublic *bool
}
The container element for a bucket's policy status.
type Progress struct {
BytesProcessed *int64
BytesReturned *int64
BytesScanned *int64
}
This data type contains information about progress of an operation.
type ProgressEvent struct {
Details *Progress
}
This data type contains information about the progress event of an operation.
Values returns all known values for Protocol. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PublicAccessBlockConfiguration struct {
BlockPublicAcls *bool
BlockPublicPolicy *bool
IgnorePublicAcls *bool
RestrictPublicBuckets *bool
}
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public"in the Amazon S3 User Guide.
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
Enum values for QuoteFields
Values returns all known values for QuoteFields. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The journal table record expiration settings for a journal table in an S3
Metadata configuration.
type RecordsEvent struct {
Payload []byte
}
The container for the records event.
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
type RedirectAllRequestsTo struct {
HostName *string
Protocol Protocol
}
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed.
type ReplicaModificationsStatus string
Enum values for ReplicaModificationsStatus
Values returns all known values for ReplicaModificationsStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
Specifies which Amazon S3 objects to replicate and where to store the replicas.
type ReplicationRuleAndOperator ¶type ReplicationRuleAndOperator struct {
Prefix *string
Tags []Tag
}
A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.
For example:
If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.
A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix , Tag , or an And child element.
type ReplicationRuleStatus string
Enum values for ReplicationRuleStatus
Values returns all known values for ReplicationRuleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for ReplicationStatus
Values returns all known values for ReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A container specifying S3 Replication Time Control (S3 RTC) related
information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.
type ReplicationTimeStatus string
Enum values for ReplicationTimeStatus
Values returns all known values for ReplicationTimeStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ReplicationTimeValue struct {
Minutes *int32
}
A container specifying the time value for S3 Replication Time Control (S3 RTC)
and replication metrics EventThreshold .
Enum values for RequestCharged
Values returns all known values for RequestCharged. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for RequestPayer
Values returns all known values for RequestPayer. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RequestPaymentConfiguration struct {
Payer Payer
}
Container for Payer.
type RequestProgress struct {
Enabled *bool
}
Container for specifying if periodic QueryProgress messages should be sent.
Container for restore job parameters.
type RestoreRequestType string
Enum values for RestoreRequestType
Values returns all known values for RestoreRequestType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RestoreStatus struct {
IsRestoreInProgress *bool
RestoreExpiryDate *time.Time
}
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objectsin the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
type S3KeyFilter struct {
FilterRules []FilterRule
}
A container for object key name prefix and suffix filtering rules.
Describes an Amazon S3 location that will receive the results of the restore request.
type S3TablesBucketType string
Enum values for S3TablesBucketType
Values returns all known values for S3TablesBucketType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type S3TablesDestination struct {
TableBucketArn *string
TableName *string
}
The destination information for a V1 S3 Metadata configuration. The
destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfigurationso that you can expire journal table records and create a live inventory table.
type S3TablesDestinationResult struct {
TableArn *string
TableBucketArn *string
TableName *string
TableNamespace *string
}
The destination information for a V1 S3 Metadata configuration. The
destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfigurationso that you can expire journal table records and create a live inventory table.
type SSEKMS struct {
KeyId *string
}
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
type SelectObjectContentEventStream interface {
}
The container for selecting objects from a content event stream.
The following types satisfy this interface:
SelectObjectContentEventStreamMemberCont SelectObjectContentEventStreamMemberEnd SelectObjectContentEventStreamMemberProgress SelectObjectContentEventStreamMemberRecords SelectObjectContentEventStreamMemberStats
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
)
func main() {
var union types.SelectObjectContentEventStream
// type switches can be used to check the union value
switch v := union.(type) {
case *types.SelectObjectContentEventStreamMemberCont:
_ = v.Value // Value is types.ContinuationEvent
case *types.SelectObjectContentEventStreamMemberEnd:
_ = v.Value // Value is types.EndEvent
case *types.SelectObjectContentEventStreamMemberProgress:
_ = v.Value // Value is types.ProgressEvent
case *types.SelectObjectContentEventStreamMemberRecords:
_ = v.Value // Value is types.RecordsEvent
case *types.SelectObjectContentEventStreamMemberStats:
_ = v.Value // Value is types.StatsEvent
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type SelectObjectContentEventStreamMemberEnd struct {
Value EndEvent
}
The End Event.
type SelectObjectContentEventStreamMemberProgress struct {
Value ProgressEvent
}
The Progress Event.
type SelectObjectContentEventStreamMemberRecords struct {
Value RecordsEvent
}
The Records Event.
type SelectObjectContentEventStreamMemberStats struct {
Value StatsEvent
}
The Stats Event.
type ServerSideEncryption string
Enum values for ServerSideEncryption
Values returns all known values for ServerSideEncryption. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PutBucketEncryption.
General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key ( aws/s3 ) in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS.
Directory buckets - Your SSE-KMS configuration can only support 1 customer managed keyper directory bucket's lifetime. The Amazon Web Services managed key( aws/s3 ) isn't supported.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.
Specifies the default server-side-encryption configuration.
Specifies the default server-side encryption configuration.
General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
Directory buckets - When you specify an KMS customer managed keyfor encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
The established temporary security credentials of the session.
Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.
Enum values for SessionMode
Values returns all known values for SessionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SimplePrefix struct {
}
To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.
type SseKmsEncryptedObjectsStatus string
Enum values for SseKmsEncryptedObjectsStatus
Values returns all known values for SseKmsEncryptedObjectsStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Stats struct {
BytesProcessed *int64
BytesReturned *int64
BytesScanned *int64
}
Container for the stats details.
type StatsEvent struct {
Details *Stats
}
Container for the Stats Event.
Enum values for StorageClass
Values returns all known values for StorageClass. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
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.
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
type StorageClassAnalysisSchemaVersion string
Enum values for StorageClassAnalysisSchemaVersion
Values returns all known values for StorageClassAnalysisSchemaVersion. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Enum values for TableSseAlgorithm
Values returns all known values for TableSseAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
A container of a key value name pair.
type Tagging struct {
TagSet []Tag
}
Container for TagSet elements.
Enum values for TaggingDirective
Values returns all known values for TaggingDirective. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Container for granting information.
Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions server access log deliveryin the Amazon S3 User Guide.
Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.
const ( TierStandard Tier = "Standard" TierBulk Tier = "Bulk" TierExpedited Tier = "Expedited" )
Enum values for Tier
Values returns all known values for Tier. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.
type TooManyParts struct {
Message *string
ErrorCodeOverride *string
}
You have attempted to add more parts than the maximum of 10000 that are
allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object.
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.
type TransitionDefaultMinimumObjectSize string
Enum values for TransitionDefaultMinimumObjectSize
Values returns all known values for TransitionDefaultMinimumObjectSize. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TransitionStorageClass string
Enum values for TransitionStorageClass
Values returns all known values for TransitionStorageClass. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
const ( TypeCanonicalUser Type = "CanonicalUser" TypeAmazonCustomerByEmail Type = "AmazonCustomerByEmail" TypeGroup Type = "Group" )
Enum values for Type
Values returns all known values for Type. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type UnknownUnionMember struct {
Tag string
Value []byte
}
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioningin the Amazon S3 API Reference.
Specifies website configuration parameters for an Amazon S3 bucket.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4