s3

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2020 License: Apache-2.0 Imports: 25 Imported by: 2,267

Documentation

Overview

Package s3 provides the client and types for making API requests to Amazon S3.

See https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01 for more information on this service.

See s3 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/s3/

Using the Client

To use Amazon S3 with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon S3 client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/s3/#New

Upload Managers

The s3manager package's Uploader provides concurrent upload of content to S3 by taking advantage of S3's Multipart APIs. The Uploader also supports both io.Reader for streaming uploads, and will also take advantage of io.ReadSeeker for optimizations if the Body satisfies that type. Once the Uploader instance is created you can call Upload concurrently from multiple goroutines safely.

// The config the S3 Uploader will use
cfg, err := external.LoadDefaultAWSConfig()

// Create an uploader with the config and default options
uploader := s3manager.NewUploader(cfg)

f, err  := os.Open(filename)
if err != nil {
    return fmt.Errorf("failed to open file %q, %v", filename, err)
}

// Upload the file to S3.
result, err := uploader.Upload(&s3manager.UploadInput{
    Bucket: aws.String(myBucket),
    Key:    aws.String(myString),
    Body:   f,
})
if err != nil {
    return fmt.Errorf("failed to upload file, %v", err)
}
fmt.Printf("file uploaded to, %s\n", aws.StringValue(result.Location))

See the s3manager package's Uploader type documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/s3/s3manager/#Uploader

Download Manager

The s3manager package's Downloader provides concurrently downloading of Objects from S3. The Downloader will write S3 Object content with an io.WriterAt. Once the Downloader instance is created you can call Upload concurrently from multiple goroutines safely.

// The config the S3 Downloader will use
cfg, err := external.LoadDefaultAWSConfig()

// Create a downloader with the config and default options
downloader := s3manager.NewDownloader(cfg)

// Create a file to write the S3 Object contents to.
f, err := os.Create(filename)
if err != nil {
    return fmt.Errorf("failed to create file %q, %v", filename, err)
}

// Write the contents of S3 Object to the file
n, err := downloader.Download(f, &s3.GetObjectInput{
    Bucket: aws.String(myBucket),
    Key:    aws.String(myString),
})
if err != nil {
    return fmt.Errorf("failed to upload file, %v", err)
}
fmt.Printf("file downloaded, %d bytes\n", n)

See the s3manager package's Downloader type documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/s3/s3manager/#Downloader

Get Bucket Region

GetBucketRegion will attempt to get the region for a bucket using a region hint to determine which AWS partition to perform the query on. Use this utility to determine the region a bucket is in.

cfg, err := external.LoadDefaultAWSConfig()

bucket := "my-bucket"
region, err := s3manager.GetBucketRegion(ctx, cfg, bucket, "us-west-2")
if err != nil {
    if aerr, ok := err.(awserr.Error); ok && aerr.Code() == "NotFound" {
         fmt.Fprintf(os.Stderr, "unable to find bucket %s's region not found\n", bucket)
    }
    return err
}
fmt.Printf("Bucket %s is in %s region\n", bucket, region)

See the s3manager package's GetBucketRegion function documentation for more information https://docs.aws.amazon.com/sdk-for-go/api/service/s3/s3manager/#GetBucketRegion

Index

Examples

Constants

View Source
const (
	ServiceName = "Amazon S3" // Service's name
	ServiceID   = "S3"        // Service's identifier
	EndpointsID = "s3"        // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeBucketAlreadyExists for service response error code
	// "BucketAlreadyExists".
	//
	// The requested bucket name is not available. The bucket namespace is shared
	// by all users of the system. Please select a different name and try again.
	ErrCodeBucketAlreadyExists = "BucketAlreadyExists"

	// ErrCodeBucketAlreadyOwnedByYou for service response error code
	// "BucketAlreadyOwnedByYou".
	//
	// The bucket you tried to create already exists, and you own it. Amazon S3
	// returns this error in all AWS 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).
	ErrCodeBucketAlreadyOwnedByYou = "BucketAlreadyOwnedByYou"

	// ErrCodeNoSuchBucket for service response error code
	// "NoSuchBucket".
	//
	// The specified bucket does not exist.
	ErrCodeNoSuchBucket = "NoSuchBucket"

	// ErrCodeNoSuchKey for service response error code
	// "NoSuchKey".
	//
	// The specified key does not exist.
	ErrCodeNoSuchKey = "NoSuchKey"

	// ErrCodeNoSuchUpload for service response error code
	// "NoSuchUpload".
	//
	// The specified multipart upload does not exist.
	ErrCodeNoSuchUpload = "NoSuchUpload"

	// ErrCodeObjectAlreadyInActiveTierError for service response error code
	// "ObjectAlreadyInActiveTierError".
	//
	// This operation is not allowed against this storage tier.
	ErrCodeObjectAlreadyInActiveTierError = "ObjectAlreadyInActiveTierError"

	// ErrCodeObjectNotInActiveTierError for service response error code
	// "ObjectNotInActiveTierError".
	//
	// The source object of the COPY operation is not in the active tier and is
	// only stored in Amazon S3 Glacier.
	ErrCodeObjectNotInActiveTierError = "ObjectNotInActiveTierError"
)

Variables

View Source
var NormalizeBucketLocationHandler = aws.NamedHandler{
	Name: "awssdk.s3.NormalizeBucketLocation",
	Fn: func(req *aws.Request) {
		if req.Error != nil {
			return
		}

		out := req.Data.(*GetBucketLocationOutput)
		loc := NormalizeBucketLocation(out.LocationConstraint)
		out.LocationConstraint = loc
	},
}

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

Replaces empty string with "us-east-1", and "EU" with "eu-west-1".

See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETlocation.html for more information on the values that can be returned.

req, result := svc.GetBucketLocationRequest(&s3.GetBucketLocationInput{
    Bucket: aws.String(bucket),
})
req.Handlers.Unmarshal.PushBackNamed(NormalizeBucketLocationHandler)
err := req.Send()

Functions

func WithNormalizeBucketLocation

func WithNormalizeBucketLocation(r *aws.Request)

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

Replaces empty string with "us-east-1", and "EU" with "eu-west-1".

See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETlocation.html for more information on the values that can be returned.

result, err := svc.GetBucketLocationWithContext(ctx,
    &s3.GetBucketLocationInput{
        Bucket: aws.String(bucket),
    },
    s3.WithNormalizeBucketLocation,
)

Types

type AbortIncompleteMultipartUpload

type AbortIncompleteMultipartUpload struct {

	// Specifies the number of days after which Amazon S3 aborts an incomplete multipart
	// upload.
	DaysAfterInitiation *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the Amazon Simple Storage Service Developer Guide.

func (AbortIncompleteMultipartUpload) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AbortIncompleteMultipartUpload) String

String returns the string representation

type AbortMultipartUploadInput

type AbortMultipartUploadInput struct {

	// The bucket name to which the upload was taking place.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Key of the object for which the multipart upload was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Upload ID that identifies the multipart upload.
	//
	// UploadId is a required field
	UploadId *string `location:"querystring" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AbortMultipartUploadInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AbortMultipartUploadInput) String

func (s AbortMultipartUploadInput) String() string

String returns the string representation

func (*AbortMultipartUploadInput) Validate

func (s *AbortMultipartUploadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AbortMultipartUploadOutput

type AbortMultipartUploadOutput struct {

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (AbortMultipartUploadOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AbortMultipartUploadOutput) String

String returns the string representation

type AbortMultipartUploadRequest

type AbortMultipartUploadRequest struct {
	*aws.Request
	Input *AbortMultipartUploadInput
	Copy  func(*AbortMultipartUploadInput) AbortMultipartUploadRequest
}

AbortMultipartUploadRequest is the request type for the AbortMultipartUpload API operation.

func (AbortMultipartUploadRequest) Send

Send marshals and sends the AbortMultipartUpload API request.

type AbortMultipartUploadResponse added in v0.9.0

type AbortMultipartUploadResponse struct {
	*AbortMultipartUploadOutput
	// contains filtered or unexported fields
}

AbortMultipartUploadResponse is the response type for the AbortMultipartUpload API operation.

func (*AbortMultipartUploadResponse) SDKResponseMetdata added in v0.9.0

func (r *AbortMultipartUploadResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AbortMultipartUpload request.

type AccelerateConfiguration

type AccelerateConfiguration struct {

	// Specifies the transfer acceleration status of the bucket.
	Status BucketAccelerateStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the Amazon Simple Storage Service Developer Guide.

func (AccelerateConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AccelerateConfiguration) String

func (s AccelerateConfiguration) String() string

String returns the string representation

type AccessControlPolicy

type AccessControlPolicy struct {

	// A list of grants.
	Grants []Grant `locationName:"AccessControlList" locationNameList:"Grant" type:"list"`

	// Container for the bucket owner's display name and ID.
	Owner *Owner `type:"structure"`
	// contains filtered or unexported fields
}

Contains the elements that set the ACL permissions for an object per grantee.

func (AccessControlPolicy) MarshalFields added in v0.3.0

func (s AccessControlPolicy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AccessControlPolicy) String

func (s AccessControlPolicy) String() string

String returns the string representation

func (*AccessControlPolicy) Validate

func (s *AccessControlPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AccessControlTranslation added in v0.2.0

type AccessControlTranslation struct {

	// Specifies the replica ownership. For default and valid values, see PUT bucket
	// replication (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html)
	// in the Amazon Simple Storage Service API Reference.
	//
	// Owner is a required field
	Owner OwnerOverride `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A container for information about access control for replicas.

func (AccessControlTranslation) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AccessControlTranslation) String added in v0.2.0

func (s AccessControlTranslation) String() string

String returns the string representation

func (*AccessControlTranslation) Validate added in v0.2.0

func (s *AccessControlTranslation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsAndOperator

type AnalyticsAndOperator struct {

	// The prefix to use when evaluating an AND predicate: The prefix that an object
	// must have to be included in the metrics results.
	Prefix *string `type:"string"`

	// The list of tags to use when evaluating an AND predicate.
	Tags []Tag `locationName:"Tag" locationNameList:"Tag" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

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.

func (AnalyticsAndOperator) MarshalFields added in v0.3.0

func (s AnalyticsAndOperator) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyticsAndOperator) String

func (s AnalyticsAndOperator) String() string

String returns the string representation

func (*AnalyticsAndOperator) Validate

func (s *AnalyticsAndOperator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsConfiguration

type AnalyticsConfiguration struct {

	// 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.
	Filter *AnalyticsFilter `type:"structure"`

	// The ID that identifies the analytics configuration.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// Contains data related to access patterns to be collected and made available
	// to analyze the tradeoffs between different storage classes.
	//
	// StorageClassAnalysis is a required field
	StorageClassAnalysis *StorageClassAnalysis `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

func (AnalyticsConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyticsConfiguration) String

func (s AnalyticsConfiguration) String() string

String returns the string representation

func (*AnalyticsConfiguration) Validate

func (s *AnalyticsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsExportDestination

type AnalyticsExportDestination struct {

	// A destination signifying output to an S3 bucket.
	//
	// S3BucketDestination is a required field
	S3BucketDestination *AnalyticsS3BucketDestination `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Where to publish the analytics results.

func (AnalyticsExportDestination) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyticsExportDestination) String

String returns the string representation

func (*AnalyticsExportDestination) Validate

func (s *AnalyticsExportDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsFilter

type AnalyticsFilter struct {

	// A conjunction (logical AND) of predicates, which is used in evaluating an
	// analytics filter. The operator must have at least two predicates.
	And *AnalyticsAndOperator `type:"structure"`

	// The prefix to use when evaluating an analytics filter.
	Prefix *string `type:"string"`

	// The tag to use when evaluating an analytics filter.
	Tag *Tag `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (AnalyticsFilter) MarshalFields added in v0.3.0

func (s AnalyticsFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyticsFilter) String

func (s AnalyticsFilter) String() string

String returns the string representation

func (*AnalyticsFilter) Validate

func (s *AnalyticsFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsS3BucketDestination

type AnalyticsS3BucketDestination struct {

	// The Amazon Resource Name (ARN) of the bucket to which data is exported.
	//
	// Bucket is a required field
	Bucket *string `type:"string" required:"true"`

	// The account ID that owns the destination S3 bucket. If no account ID is provided,
	// the owner is not validated before exporting data.
	//
	// Although this value is optional, we strongly recommend that you set it to
	// help prevent problems if the destination bucket ownership changes.
	BucketAccountId *string `type:"string"`

	// Specifies the file format used when exporting data to Amazon S3.
	//
	// Format is a required field
	Format AnalyticsS3ExportFileFormat `type:"string" required:"true" enum:"true"`

	// The prefix to use when exporting data. The prefix is prepended to all results.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about where to publish the analytics results.

func (AnalyticsS3BucketDestination) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyticsS3BucketDestination) String

String returns the string representation

func (*AnalyticsS3BucketDestination) Validate

func (s *AnalyticsS3BucketDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsS3ExportFileFormat

type AnalyticsS3ExportFileFormat string
const (
	AnalyticsS3ExportFileFormatCsv AnalyticsS3ExportFileFormat = "CSV"
)

Enum values for AnalyticsS3ExportFileFormat

func (AnalyticsS3ExportFileFormat) MarshalValue added in v0.3.0

func (enum AnalyticsS3ExportFileFormat) MarshalValue() (string, error)

func (AnalyticsS3ExportFileFormat) MarshalValueBuf added in v0.3.0

func (enum AnalyticsS3ExportFileFormat) MarshalValueBuf(b []byte) ([]byte, error)

type Bucket

type Bucket struct {

	// Date the bucket was created.
	CreationDate *time.Time `type:"timestamp"`

	// The name of the bucket.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all AWS accounts.

func (Bucket) MarshalFields added in v0.3.0

func (s Bucket) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Bucket) String

func (s Bucket) String() string

String returns the string representation

type BucketAccelerateStatus

type BucketAccelerateStatus string
const (
	BucketAccelerateStatusEnabled   BucketAccelerateStatus = "Enabled"
	BucketAccelerateStatusSuspended BucketAccelerateStatus = "Suspended"
)

Enum values for BucketAccelerateStatus

func (BucketAccelerateStatus) MarshalValue added in v0.3.0

func (enum BucketAccelerateStatus) MarshalValue() (string, error)

func (BucketAccelerateStatus) MarshalValueBuf added in v0.3.0

func (enum BucketAccelerateStatus) MarshalValueBuf(b []byte) ([]byte, error)

type BucketCannedACL

type BucketCannedACL string
const (
	BucketCannedACLPrivate           BucketCannedACL = "private"
	BucketCannedACLPublicRead        BucketCannedACL = "public-read"
	BucketCannedACLPublicReadWrite   BucketCannedACL = "public-read-write"
	BucketCannedACLAuthenticatedRead BucketCannedACL = "authenticated-read"
)

Enum values for BucketCannedACL

func (BucketCannedACL) MarshalValue added in v0.3.0

func (enum BucketCannedACL) MarshalValue() (string, error)

func (BucketCannedACL) MarshalValueBuf added in v0.3.0

func (enum BucketCannedACL) MarshalValueBuf(b []byte) ([]byte, error)

type BucketLifecycleConfiguration

type BucketLifecycleConfiguration struct {

	// A lifecycle rule for individual objects in an Amazon S3 bucket.
	//
	// Rules is a required field
	Rules []LifecycleRule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the Amazon Simple Storage Service Developer Guide.

func (BucketLifecycleConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BucketLifecycleConfiguration) String

String returns the string representation

func (*BucketLifecycleConfiguration) Validate

func (s *BucketLifecycleConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BucketLocationConstraint

type BucketLocationConstraint string
const (
	BucketLocationConstraintEu           BucketLocationConstraint = "EU"
	BucketLocationConstraintEuWest1      BucketLocationConstraint = "eu-west-1"
	BucketLocationConstraintUsWest1      BucketLocationConstraint = "us-west-1"
	BucketLocationConstraintUsWest2      BucketLocationConstraint = "us-west-2"
	BucketLocationConstraintApSouth1     BucketLocationConstraint = "ap-south-1"
	BucketLocationConstraintApSoutheast1 BucketLocationConstraint = "ap-southeast-1"
	BucketLocationConstraintApSoutheast2 BucketLocationConstraint = "ap-southeast-2"
	BucketLocationConstraintApNortheast1 BucketLocationConstraint = "ap-northeast-1"
	BucketLocationConstraintSaEast1      BucketLocationConstraint = "sa-east-1"
	BucketLocationConstraintCnNorth1     BucketLocationConstraint = "cn-north-1"
	BucketLocationConstraintEuCentral1   BucketLocationConstraint = "eu-central-1"
)

Enum values for BucketLocationConstraint

func NormalizeBucketLocation

func NormalizeBucketLocation(loc BucketLocationConstraint) BucketLocationConstraint

NormalizeBucketLocation is a utility function which will update the passed in value to always be a region ID. Generally this would be used with GetBucketLocation API operation.

Replaces empty string with "us-east-1", and "EU" with "eu-west-1".

See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETlocation.html for more information on the values that can be returned.

func (BucketLocationConstraint) MarshalValue added in v0.3.0

func (enum BucketLocationConstraint) MarshalValue() (string, error)

func (BucketLocationConstraint) MarshalValueBuf added in v0.3.0

func (enum BucketLocationConstraint) MarshalValueBuf(b []byte) ([]byte, error)

type BucketLoggingStatus

type BucketLoggingStatus struct {

	// 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 logging
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html)
	// in the Amazon Simple Storage Service API Reference.
	LoggingEnabled *LoggingEnabled `type:"structure"`
	// contains filtered or unexported fields
}

Container for logging status information.

func (BucketLoggingStatus) MarshalFields added in v0.3.0

func (s BucketLoggingStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BucketLoggingStatus) String

func (s BucketLoggingStatus) String() string

String returns the string representation

func (*BucketLoggingStatus) Validate

func (s *BucketLoggingStatus) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BucketLogsPermission

type BucketLogsPermission string
const (
	BucketLogsPermissionFullControl BucketLogsPermission = "FULL_CONTROL"
	BucketLogsPermissionRead        BucketLogsPermission = "READ"
	BucketLogsPermissionWrite       BucketLogsPermission = "WRITE"
)

Enum values for BucketLogsPermission

func (BucketLogsPermission) MarshalValue added in v0.3.0

func (enum BucketLogsPermission) MarshalValue() (string, error)

func (BucketLogsPermission) MarshalValueBuf added in v0.3.0

func (enum BucketLogsPermission) MarshalValueBuf(b []byte) ([]byte, error)

type BucketVersioningStatus

type BucketVersioningStatus string
const (
	BucketVersioningStatusEnabled   BucketVersioningStatus = "Enabled"
	BucketVersioningStatusSuspended BucketVersioningStatus = "Suspended"
)

Enum values for BucketVersioningStatus

func (BucketVersioningStatus) MarshalValue added in v0.3.0

func (enum BucketVersioningStatus) MarshalValue() (string, error)

func (BucketVersioningStatus) MarshalValueBuf added in v0.3.0

func (enum BucketVersioningStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CORSConfiguration

type CORSConfiguration struct {

	// A set of origins and methods (cross-origin access that you want to allow).
	// You can add up to 100 rules to the configuration.
	//
	// CORSRules is a required field
	CORSRules []CORSRule `locationName:"CORSRule" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon Simple Storage Service Developer Guide.

func (CORSConfiguration) MarshalFields added in v0.3.0

func (s CORSConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CORSConfiguration) String

func (s CORSConfiguration) String() string

String returns the string representation

func (*CORSConfiguration) Validate

func (s *CORSConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CORSRule

type CORSRule struct {

	// Headers that are specified in the Access-Control-Request-Headers header.
	// These headers are allowed in a preflight OPTIONS request. In response to
	// any preflight OPTIONS request, Amazon S3 returns any requested headers that
	// are allowed.
	AllowedHeaders []string `locationName:"AllowedHeader" type:"list" flattened:"true"`

	// An HTTP method that you allow the origin to execute. Valid values are GET,
	// PUT, HEAD, POST, and DELETE.
	//
	// AllowedMethods is a required field
	AllowedMethods []string `locationName:"AllowedMethod" type:"list" flattened:"true" required:"true"`

	// One or more origins you want customers to be able to access the bucket from.
	//
	// AllowedOrigins is a required field
	AllowedOrigins []string `locationName:"AllowedOrigin" type:"list" flattened:"true" required:"true"`

	// One or more headers in the response that you want customers to be able to
	// access from their applications (for example, from a JavaScript XMLHttpRequest
	// object).
	ExposeHeaders []string `locationName:"ExposeHeader" type:"list" flattened:"true"`

	// The time in seconds that your browser is to cache the preflight response
	// for the specified resource.
	MaxAgeSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies a cross-origin access rule for an Amazon S3 bucket.

func (CORSRule) MarshalFields added in v0.3.0

func (s CORSRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CORSRule) String

func (s CORSRule) String() string

String returns the string representation

func (*CORSRule) Validate

func (s *CORSRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CSVInput added in v0.2.0

type CSVInput struct {

	// Specifies that CSV field values may contain quoted record delimiters and
	// such records should be allowed. Default value is FALSE. Setting this value
	// to TRUE may lower performance.
	AllowQuotedRecordDelimiter *bool `type:"boolean"`

	// A single character used to indicate that a row should be ignored when the
	// character is present at the start of that row. You can specify any character
	// to indicate a comment line.
	Comments *string `type:"string"`

	// A single character used to separate individual fields in a record. You can
	// specify an arbitrary delimiter.
	FieldDelimiter *string `type:"string"`

	// Describes the first line of input. Valid values are:
	//
	//    * NONE: First line is not a header.
	//
	//    * IGNORE: First line is a header, but you can't use the header values
	//    to indicate the column in an expression. You can use column position (such
	//    as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).
	//
	//    * Use: First line is a header, and you can use the header value to identify
	//    a column in an expression (SELECT "name" FROM OBJECT).
	FileHeaderInfo FileHeaderInfo `type:"string" enum:"true"`

	// A single character used for escaping when the field delimiter is part of
	// the value. For example, if the value is a, b, Amazon S3 wraps this field
	// value in quotation marks, as follows: " a , b ".
	//
	// Type: String
	//
	// Default: "
	//
	// Ancestors: CSV
	QuoteCharacter *string `type:"string"`

	// A single character used for escaping the quotation mark character inside
	// an already escaped value. For example, the value """ a , b """ is parsed
	// as " a , b ".
	QuoteEscapeCharacter *string `type:"string"`

	// A single character used to separate individual records in the input. Instead
	// of the default value, you can specify an arbitrary delimiter.
	RecordDelimiter *string `type:"string"`
	// contains filtered or unexported fields
}

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

func (CSVInput) MarshalFields added in v0.3.0

func (s CSVInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CSVInput) String added in v0.2.0

func (s CSVInput) String() string

String returns the string representation

type CSVOutput added in v0.2.0

type CSVOutput struct {

	// The value used to separate individual fields in a record. You can specify
	// an arbitrary delimiter.
	FieldDelimiter *string `type:"string"`

	// A single character used for escaping when the field delimiter is part of
	// the value. For example, if the value is a, b, Amazon S3 wraps this field
	// value in quotation marks, as follows: " a , b ".
	QuoteCharacter *string `type:"string"`

	// The single character used for escaping the quote character inside an already
	// escaped value.
	QuoteEscapeCharacter *string `type:"string"`

	// Indicates whether to use quotation marks around output fields.
	//
	//    * ALWAYS: Always use quotation marks for output fields.
	//
	//    * ASNEEDED: Use quotation marks for output fields when needed.
	QuoteFields QuoteFields `type:"string" enum:"true"`

	// A single character used to separate individual records in the output. Instead
	// of the default value, you can specify an arbitrary delimiter.
	RecordDelimiter *string `type:"string"`
	// contains filtered or unexported fields
}

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

func (CSVOutput) MarshalFields added in v0.3.0

func (s CSVOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CSVOutput) String added in v0.2.0

func (s CSVOutput) String() string

String returns the string representation

type Client added in v0.9.0

type Client struct {
	*aws.Client

	// Disables the S3 client from using the Expect: 100-Continue header to wait for
	// the service to respond with a 100 status code before sending the HTTP request
	// body.
	//
	// You should disable 100-Continue if you experience issues with proxies or third
	// party S3 compatible services.
	//
	// See http.Transport's ExpectContinueTimeout for information on adjusting the
	// continue wait timeout. https://golang.org/pkg/net/http/#Transport
	Disable100Continue bool

	// Forces the client to use path-style addressing for S3 API operations. By
	// default the S3 client will use virtual hosted bucket addressing when possible.
	// The S3 client will automatically fall back to path-style when the bucket name
	// is not DNS compatible.
	//
	// With ForcePathStyle
	//
	// 	https://s3.us-west-2.amazonaws.com/BUCKET/KEY
	//
	// Without ForcePathStyle
	//
	// 	https://BUCKET.s3.us-west-2.amazonaws.com/KEY
	//
	// See http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
	ForcePathStyle bool

	// Enables S3 Accelerate feature for API operation that support S3 Accelerate.
	// For all operations compatible with S3 Accelerate will use the accelerate
	// endpoint for requests. Requests not compatible will fall back to normal S3
	// requests.
	//
	// The bucket must be enable for accelerate to be used with S3 client with
	// accelerate enabled. If the bucket is not enabled for accelerate an error will
	// be returned. The bucket name must be DNS compatible to also work with
	// accelerate.
	//
	UseAccelerate bool

	// Set this to `true` to use the region specified
	// in the ARN, when an ARN is provided as an argument to a bucket parameter.
	UseARNRegion bool
}

Client provides the API operation methods for making requests to Amazon S3. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := s3.New(myConfig)

func (*Client) AbortMultipartUploadRequest added in v0.9.0

func (c *Client) AbortMultipartUploadRequest(input *AbortMultipartUploadInput) AbortMultipartUploadRequest

AbortMultipartUploadRequest returns a request value for making API operation for Amazon Simple Storage Service.

This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).

The following operations are related to AbortMultipartUpload:

  • CreateMultipartUpload

  • UploadPart

  • CompleteMultipartUpload

  • ListParts

  • ListMultipartUploads

    // Example sending a request using AbortMultipartUploadRequest. req := client.AbortMultipartUploadRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload

Example (Shared00)

To abort a multipart upload

The following example aborts a multipart upload.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.AbortMultipartUploadInput{
		Bucket:   aws.String("examplebucket"),
		Key:      aws.String("bigobject"),
		UploadId: aws.String("xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"),
	}

	req := svc.AbortMultipartUploadRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchUpload:
				fmt.Println(s3.ErrCodeNoSuchUpload, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CompleteMultipartUploadRequest added in v0.9.0

func (c *Client) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) CompleteMultipartUploadRequest

CompleteMultipartUploadRequest returns a request value for making API operation for Amazon Simple Storage Service.

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices (https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html).

For more information about multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html).

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).

GetBucketLifecycle has the following special errors:

  • Error code: EntityTooSmall Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part. 400 Bad Request

  • Error code: InvalidPart Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag. 400 Bad Request

  • Error code: InvalidPartOrder Description: The list of parts was not in ascending order. The parts list must be specified in order by part number. 400 Bad Request

  • Error code: NoSuchUpload Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. 404 Not Found

The following operations are related to CompleteMultipartUpload:

  • CreateMultipartUpload

  • UploadPart

  • AbortMultipartUpload

  • ListParts

  • ListMultipartUploads

    // Example sending a request using CompleteMultipartUploadRequest. req := client.CompleteMultipartUploadRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUpload

Example (Shared00)

To complete multipart upload

The following example completes a multipart upload.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.CompleteMultipartUploadInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("bigobject"),
		MultipartUpload: &s3.CompletedMultipartUpload{
			Parts: []s3.CompletedPart{
				{
					ETag:       aws.String("\"d8c2eafd90c266e19ab9dcacc479f8af\""),
					PartNumber: aws.Int64(1),
				},
				{
					ETag:       aws.String("\"d8c2eafd90c266e19ab9dcacc479f8af\""),
					PartNumber: aws.Int64(2),
				},
			},
		},
		UploadId: aws.String("7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"),
	}

	req := svc.CompleteMultipartUploadRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CopyObjectRequest added in v0.9.0

func (c *Client) CopyObjectRequest(input *CopyObjectInput) CopyObjectRequest

CopyObjectRequest returns a request value for making API operation for Amazon Simple Storage Service.

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html).

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.

If the copy is successful, you receive a response with information about the copied object.

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing (https://aws.amazon.com/s3/pricing/).

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).

Metadata

When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).

To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html).

x-amz-copy-source-if Headers

To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:

  • x-amz-copy-source-if-match

  • x-amz-copy-source-if-none-match

  • x-amz-copy-source-if-unmodified-since

  • x-amz-copy-source-if-modified-since

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

  • x-amz-copy-source-if-match condition evaluates to true

  • x-amz-copy-source-if-unmodified-since condition evaluates to false

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

  • x-amz-copy-source-if-none-match condition evaluates to false

  • x-amz-copy-source-if-modified-since condition evaluates to true

All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.

Encryption

The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.

You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html).

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing ACLs Using the REST API (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html).

Storage Class Options

You can use the CopyObject operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the Amazon S3 Service Developer Guide.

Versioning

By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see .

The following operations are related to CopyObject:

  • PutObject

  • GetObject

For more information, see Copying Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html).

// Example sending a request using CopyObjectRequest.
req := client.CopyObjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject

Example (Shared00)

To copy an object

The following example copies an object from one bucket to another.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.CopyObjectInput{
		Bucket:     aws.String("destinationbucket"),
		CopySource: aws.String("/sourcebucket/HappyFacejpg"),
		Key:        aws.String("HappyFaceCopyjpg"),
	}

	req := svc.CopyObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeObjectNotInActiveTierError:
				fmt.Println(s3.ErrCodeObjectNotInActiveTierError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateBucketRequest added in v0.9.0

func (c *Client) CreateBucketRequest(input *CreateBucketInput) CreateBucketRequest

CreateBucketRequest returns a request value for making API operation for Amazon Simple Storage Service.

Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html).

By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see How to Select a Region for Your Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).

If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html).

When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.

  • Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).

  • Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata: x-amz-grant-read: id="11112222333", id="444455556666"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

The following operations are related to CreateBucket:

  • PutObject

  • DeleteBucket

    // Example sending a request using CreateBucketRequest. req := client.CreateBucketRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket

Example (Shared00)

To create a bucket

The following example creates a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.CreateBucketInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.CreateBucketRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeBucketAlreadyExists:
				fmt.Println(s3.ErrCodeBucketAlreadyExists, aerr.Error())
			case s3.ErrCodeBucketAlreadyOwnedByYou:
				fmt.Println(s3.ErrCodeBucketAlreadyOwnedByYou, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To create a bucket in a specific region

The following example creates a bucket. The request specifies an AWS region where to create the bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.CreateBucketInput{
		Bucket: aws.String("examplebucket"),
		CreateBucketConfiguration: &s3.CreateBucketConfiguration{
			LocationConstraint: s3.BucketLocationConstraintEuWest1,
		},
	}

	req := svc.CreateBucketRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeBucketAlreadyExists:
				fmt.Println(s3.ErrCodeBucketAlreadyExists, aerr.Error())
			case s3.ErrCodeBucketAlreadyOwnedByYou:
				fmt.Println(s3.ErrCodeBucketAlreadyOwnedByYou, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateMultipartUploadRequest added in v0.9.0

func (c *Client) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) CreateMultipartUploadRequest

CreateMultipartUploadRequest returns a request value for making API operation for Amazon Simple Storage Service.

This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html).

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).

For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.

To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html).

Access Permissions

When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.

  • Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html).

  • Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html).

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). With this operation, you can grant access permissions using one of the following two methods:

  • Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).

  • Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata: x-amz-grant-read: id="11112222333", id="444455556666"

The following operations are related to CreateMultipartUpload:

  • UploadPart

  • CompleteMultipartUpload

  • AbortMultipartUpload

  • ListParts

  • ListMultipartUploads

    // Example sending a request using CreateMultipartUploadRequest. req := client.CreateMultipartUploadRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload

Example (Shared00)

To initiate a multipart upload

The following example initiates a multipart upload.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.CreateMultipartUploadInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("largeobject"),
	}

	req := svc.CreateMultipartUploadRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketAnalyticsConfigurationRequest added in v0.9.0

func (c *Client) DeleteBucketAnalyticsConfigurationRequest(input *DeleteBucketAnalyticsConfigurationInput) DeleteBucketAnalyticsConfigurationRequest

DeleteBucketAnalyticsConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).

The following operations are related to DeleteBucketAnalyticsConfiguration:

*

*

*

// Example sending a request using DeleteBucketAnalyticsConfigurationRequest.
req := client.DeleteBucketAnalyticsConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfiguration

func (*Client) DeleteBucketCorsRequest added in v0.9.0

func (c *Client) DeleteBucketCorsRequest(input *DeleteBucketCorsInput) DeleteBucketCorsRequest

DeleteBucketCorsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

For information about cors, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon Simple Storage Service Developer Guide.

Related Resources:

*

* RESTOPTIONSobject

// Example sending a request using DeleteBucketCorsRequest.
req := client.DeleteBucketCorsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors

Example (Shared00)

To delete cors configuration on a bucket.

The following example deletes CORS configuration on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketCorsInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.DeleteBucketCorsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketEncryptionRequest added in v0.9.0

func (c *Client) DeleteBucketEncryptionRequest(input *DeleteBucketEncryptionInput) DeleteBucketEncryptionRequest

DeleteBucketEncryptionRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

Related Resources

  • PutBucketEncryption

  • GetBucketEncryption

    // Example sending a request using DeleteBucketEncryptionRequest. req := client.DeleteBucketEncryptionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryption

func (*Client) DeleteBucketInventoryConfigurationRequest added in v0.9.0

func (c *Client) DeleteBucketInventoryConfigurationRequest(input *DeleteBucketInventoryConfigurationInput) DeleteBucketInventoryConfigurationRequest

DeleteBucketInventoryConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).

Operations related to DeleteBucketInventoryConfiguration include:

  • GetBucketInventoryConfiguration

  • PutBucketInventoryConfiguration

  • ListBucketInventoryConfigurations

    // Example sending a request using DeleteBucketInventoryConfigurationRequest. req := client.DeleteBucketInventoryConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfiguration

func (*Client) DeleteBucketLifecycleRequest added in v0.9.0

func (c *Client) DeleteBucketLifecycleRequest(input *DeleteBucketLifecycleInput) DeleteBucketLifecycleRequest

DeleteBucketLifecycleRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

For more information about the object expiration, see Elements to Describe Lifecycle Actions (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).

Related actions include:

  • PutBucketLifecycleConfiguration

  • GetBucketLifecycleConfiguration

    // Example sending a request using DeleteBucketLifecycleRequest. req := client.DeleteBucketLifecycleRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle

Example (Shared00)

To delete lifecycle configuration on a bucket.

The following example deletes lifecycle configuration on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketLifecycleInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.DeleteBucketLifecycleRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketMetricsConfigurationRequest added in v0.9.0

func (c *Client) DeleteBucketMetricsConfigurationRequest(input *DeleteBucketMetricsConfigurationInput) DeleteBucketMetricsConfigurationRequest

DeleteBucketMetricsConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).

The following operations are related to DeleteBucketMetricsConfiguration:

  • GetBucketMetricsConfiguration

  • PutBucketMetricsConfiguration

  • ListBucketMetricsConfigurations

  • Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)

    // Example sending a request using DeleteBucketMetricsConfigurationRequest. req := client.DeleteBucketMetricsConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfiguration

func (*Client) DeleteBucketPolicyRequest added in v0.9.0

func (c *Client) DeleteBucketPolicyRequest(input *DeleteBucketPolicyInput) DeleteBucketPolicyRequest

DeleteBucketPolicyRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and UserPolicies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

The following operations are related to DeleteBucketPolicy

  • CreateBucket

  • DeleteObject

    // Example sending a request using DeleteBucketPolicyRequest. req := client.DeleteBucketPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy

Example (Shared00)

To delete bucket policy

The following example deletes bucket policy on the specified bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketPolicyInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.DeleteBucketPolicyRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketReplicationRequest added in v0.9.0

func (c *Client) DeleteBucketReplicationRequest(input *DeleteBucketReplicationInput) DeleteBucketReplicationRequest

DeleteBucketReplicationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon S3 Developer Guide.

The following operations are related to DeleteBucketReplication:

  • PutBucketReplication

  • GetBucketReplication

    // Example sending a request using DeleteBucketReplicationRequest. req := client.DeleteBucketReplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplication

Example (Shared00)

To delete bucket replication configuration

The following example deletes replication configuration set on bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketReplicationInput{
		Bucket: aws.String("example"),
	}

	req := svc.DeleteBucketReplicationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketRequest added in v0.9.0

func (c *Client) DeleteBucketRequest(input *DeleteBucketInput) DeleteBucketRequest

DeleteBucketRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Related Resources

*

*

// Example sending a request using DeleteBucketRequest.
req := client.DeleteBucketRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket

Example (Shared00)

To delete a bucket

The following example deletes the specified bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketInput{
		Bucket: aws.String("forrandall2"),
	}

	req := svc.DeleteBucketRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketTaggingRequest added in v0.9.0

func (c *Client) DeleteBucketTaggingRequest(input *DeleteBucketTaggingInput) DeleteBucketTaggingRequest

DeleteBucketTaggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to DeleteBucketTagging:

  • GetBucketTagging

  • PutBucketTagging

    // Example sending a request using DeleteBucketTaggingRequest. req := client.DeleteBucketTaggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging

Example (Shared00)

To delete bucket tags

The following example deletes bucket tags.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketTaggingInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.DeleteBucketTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteBucketWebsiteRequest added in v0.9.0

func (c *Client) DeleteBucketWebsiteRequest(input *DeleteBucketWebsiteInput) DeleteBucketWebsiteRequest

DeleteBucketWebsiteRequest returns a request value for making API operation for Amazon Simple Storage Service.

This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).

The following operations are related to DeleteBucketWebsite:

  • GetBucketWebsite

  • PutBucketWebsite

    // Example sending a request using DeleteBucketWebsiteRequest. req := client.DeleteBucketWebsiteRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite

Example (Shared00)

To delete bucket website configuration

The following example deletes bucket website configuration.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteBucketWebsiteInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.DeleteBucketWebsiteRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteObjectRequest added in v0.9.0

func (c *Client) DeleteObjectRequest(input *DeleteObjectInput) DeleteObjectRequest

DeleteObjectRequest returns a request value for making API operation for Amazon Simple Storage Service.

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html). To see sample requests that use versioning, see Sample Request (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete).

You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following operation is related to DeleteObject:

  • PutObject

    // Example sending a request using DeleteObjectRequest. req := client.DeleteObjectRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject

Example (Shared00)

To delete an object

The following example deletes an object from an S3 bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteObjectInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("objectkey.jpg"),
	}

	req := svc.DeleteObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To delete an object (from a non-versioned bucket)

The following example deletes an object from a non-versioned bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteObjectInput{
		Bucket: aws.String("ExampleBucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.DeleteObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteObjectTaggingRequest added in v0.9.0

func (c *Client) DeleteObjectTaggingRequest(input *DeleteObjectTaggingInput) DeleteObjectTaggingRequest

DeleteObjectTaggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteBucketMetricsConfiguration:

  • PutObjectTagging

  • GetObjectTagging

    // Example sending a request using DeleteObjectTaggingRequest. req := client.DeleteObjectTaggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTagging

Example (Shared00)

To remove tag set from an object version

The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteObjectTaggingInput{
		Bucket:    aws.String("examplebucket"),
		Key:       aws.String("HappyFace.jpg"),
		VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"),
	}

	req := svc.DeleteObjectTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To remove tag set from an object

The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteObjectTaggingInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.DeleteObjectTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteObjectsRequest added in v0.9.0

func (c *Client) DeleteObjectsRequest(input *DeleteObjectsInput) DeleteObjectsRequest

DeleteObjectsRequest returns a request value for making API operation for Amazon Simple Storage Service.

This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.

When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete).

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

The following operations are related to DeleteObjects:

  • CreateMultipartUpload

  • UploadPart

  • CompleteMultipartUpload

  • ListParts

  • AbortMultipartUpload

    // Example sending a request using DeleteObjectsRequest. req := client.DeleteObjectsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects

Example (Shared00)

To delete multiple object versions from a versioned bucket

The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteObjectsInput{
		Bucket: aws.String("examplebucket"),
		Delete: &s3.Delete{
			Objects: []s3.ObjectIdentifier{
				{
					Key:       aws.String("HappyFace.jpg"),
					VersionId: aws.String("2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"),
				},
				{
					Key:       aws.String("HappyFace.jpg"),
					VersionId: aws.String("yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"),
				},
			},
			Quiet: aws.Bool(false),
		},
	}

	req := svc.DeleteObjectsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To delete multiple objects from a versioned bucket

The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.DeleteObjectsInput{
		Bucket: aws.String("examplebucket"),
		Delete: &s3.Delete{
			Objects: []s3.ObjectIdentifier{
				{
					Key: aws.String("objectkey1"),
				},
				{
					Key: aws.String("objectkey2"),
				},
			},
			Quiet: aws.Bool(false),
		},
	}

	req := svc.DeleteObjectsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeletePublicAccessBlockRequest added in v0.9.0

func (c *Client) DeletePublicAccessBlockRequest(input *DeletePublicAccessBlockInput) DeletePublicAccessBlockRequest

DeletePublicAccessBlockRequest returns a request value for making API operation for Amazon Simple Storage Service.

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

The following operations are related to DeletePublicAccessBlock:

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlock

func (*Client) GetBucketAccelerateConfigurationRequest added in v0.9.0

func (c *Client) GetBucketAccelerateConfigurationRequest(input *GetBucketAccelerateConfigurationInput) GetBucketAccelerateConfigurationRequest

GetBucketAccelerateConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the Amazon Simple Storage Service Developer Guide.

Related Resources

  • PutBucketAccelerateConfiguration

    // Example sending a request using GetBucketAccelerateConfigurationRequest. req := client.GetBucketAccelerateConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration

func (*Client) GetBucketAclRequest added in v0.9.0

func (c *Client) GetBucketAclRequest(input *GetBucketAclInput) GetBucketAclRequest

GetBucketAclRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

Related Resources

*

// Example sending a request using GetBucketAclRequest.
req := client.GetBucketAclRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl

func (*Client) GetBucketAnalyticsConfigurationRequest added in v0.9.0

func (c *Client) GetBucketAnalyticsConfigurationRequest(input *GetBucketAnalyticsConfigurationInput) GetBucketAnalyticsConfigurationRequest

GetBucketAnalyticsConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) in the Amazon Simple Storage Service Developer Guide.

Related Resources

*

*

*

// Example sending a request using GetBucketAnalyticsConfigurationRequest.
req := client.GetBucketAnalyticsConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfiguration

func (*Client) GetBucketCorsRequest added in v0.9.0

func (c *Client) GetBucketCorsRequest(input *GetBucketCorsInput) GetBucketCorsRequest

GetBucketCorsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

For more information about cors, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html).

The following operations are related to GetBucketCors:

  • PutBucketCors

  • DeleteBucketCors

    // Example sending a request using GetBucketCorsRequest. req := client.GetBucketCorsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors

Example (Shared00)

To get cors configuration set on a bucket

The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketCorsInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketCorsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketEncryptionRequest added in v0.9.0

func (c *Client) GetBucketEncryptionRequest(input *GetBucketEncryptionInput) GetBucketEncryptionRequest

GetBucketEncryptionRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html).

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

The following operations are related to GetBucketEncryption:

  • PutBucketEncryption

  • DeleteBucketEncryption

    // Example sending a request using GetBucketEncryptionRequest. req := client.GetBucketEncryptionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryption

func (*Client) GetBucketInventoryConfigurationRequest added in v0.9.0

func (c *Client) GetBucketInventoryConfigurationRequest(input *GetBucketInventoryConfigurationInput) GetBucketInventoryConfigurationRequest

GetBucketInventoryConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).

The following operations are related to GetBucketInventoryConfiguration:

  • DeleteBucketInventoryConfiguration

  • ListBucketInventoryConfigurations

  • PutBucketInventoryConfiguration

    // Example sending a request using GetBucketInventoryConfigurationRequest. req := client.GetBucketInventoryConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration

func (*Client) GetBucketLifecycleConfigurationRequest added in v0.9.0

func (c *Client) GetBucketLifecycleConfigurationRequest(input *GetBucketLifecycleConfigurationInput) GetBucketLifecycleConfigurationRequest

GetBucketLifecycleConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html).

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

GetBucketLifecycleConfiguration has the following special error:

  • Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycleConfiguration:

  • GetBucketLifecycle

  • PutBucketLifecycle

  • DeleteBucketLifecycle

    // Example sending a request using GetBucketLifecycleConfigurationRequest. req := client.GetBucketLifecycleConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration

Example (Shared00)

To get lifecycle configuration on a bucket

The following example retrieves lifecycle configuration on set on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketLifecycleConfigurationInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketLifecycleConfigurationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketLifecycleRequest added in v0.9.0

func (c *Client) GetBucketLifecycleRequest(input *GetBucketLifecycleInput) GetBucketLifecycleRequest

GetBucketLifecycleRequest returns a request value for making API operation for Amazon Simple Storage Service.

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html).

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

GetBucketLifecycle has the following special error:

  • Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycle:

  • GetBucketLifecycleConfiguration

  • PutBucketLifecycle

  • DeleteBucketLifecycle

    // Example sending a request using GetBucketLifecycleRequest. req := client.GetBucketLifecycleRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycle

Example (Shared00)

To get a bucket acl

The following example gets ACL on the specified bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketLifecycleInput{
		Bucket: aws.String("acl1"),
	}

	req := svc.GetBucketLifecycleRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketLocationRequest added in v0.9.0

func (c *Client) GetBucketLocationRequest(input *GetBucketLocationInput) GetBucketLocationRequest

GetBucketLocationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this implementation of the operation, you must be the bucket owner.

The following operations are related to GetBucketLocation:

  • GetObject

  • CreateBucket

    // Example sending a request using GetBucketLocationRequest. req := client.GetBucketLocationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation

Example (Shared00)

To get bucket location

The following example returns bucket location.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketLocationInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketLocationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketLoggingRequest added in v0.9.0

func (c *Client) GetBucketLoggingRequest(input *GetBucketLoggingInput) GetBucketLoggingRequest

GetBucketLoggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

The following operations are related to GetBucketLogging:

  • CreateBucket

  • PutBucketLogging

    // Example sending a request using GetBucketLoggingRequest. req := client.GetBucketLoggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging

func (*Client) GetBucketMetricsConfigurationRequest added in v0.9.0

func (c *Client) GetBucketMetricsConfigurationRequest(input *GetBucketMetricsConfigurationInput) GetBucketMetricsConfigurationRequest

GetBucketMetricsConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).

The following operations are related to GetBucketMetricsConfiguration:

  • PutBucketMetricsConfiguration

  • DeleteBucketMetricsConfiguration

  • ListBucketMetricsConfigurations

  • Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)

    // Example sending a request using GetBucketMetricsConfigurationRequest. req := client.GetBucketMetricsConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfiguration

func (*Client) GetBucketNotificationConfigurationRequest added in v0.9.0

func (c *Client) GetBucketNotificationConfigurationRequest(input *GetBucketNotificationConfigurationInput) GetBucketNotificationConfigurationRequest

GetBucketNotificationConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). For more information about bucket policies, see Using Bucket Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

The following operation is related to GetBucketNotification:

  • PutBucketNotification

    // Example sending a request using GetBucketNotificationConfigurationRequest. req := client.GetBucketNotificationConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration

func (*Client) GetBucketNotificationRequest added in v0.9.0

func (c *Client) GetBucketNotificationRequest(input *GetBucketNotificationInput) GetBucketNotificationRequest

GetBucketNotificationRequest returns a request value for making API operation for Amazon Simple Storage Service.

No longer used, see GetBucketNotificationConfiguration.

// Example sending a request using GetBucketNotificationRequest.
req := client.GetBucketNotificationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotification

Example (Shared00)

To get notification configuration set on a bucket

The following example returns notification configuration set on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketNotificationInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketNotificationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To get notification configuration set on a bucket

The following example returns notification configuration set on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketNotificationInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketNotificationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketPolicyRequest added in v0.9.0

func (c *Client) GetBucketPolicyRequest(input *GetBucketPolicyInput) GetBucketPolicyRequest

GetBucketPolicyRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

The following operation is related to GetBucketPolicy:

  • GetObject

    // Example sending a request using GetBucketPolicyRequest. req := client.GetBucketPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy

Example (Shared00)

To get bucket policy

The following example returns bucket policy associated with a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketPolicyInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketPolicyRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketPolicyStatusRequest added in v0.9.0

func (c *Client) GetBucketPolicyStatusRequest(input *GetBucketPolicyStatusInput) GetBucketPolicyStatusRequest

GetBucketPolicyStatusRequest returns a request value for making API operation for Amazon Simple Storage Service.

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).

The following operations are related to GetBucketPolicyStatus:

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatus

func (*Client) GetBucketReplicationRequest added in v0.9.0

func (c *Client) GetBucketReplicationRequest(input *GetBucketReplicationInput) GetBucketReplicationRequest

GetBucketReplicationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon Simple Storage Service Developer Guide.

This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

For information about GetBucketReplication errors, see ReplicationErrorCodeList

The following operations are related to GetBucketReplication:

  • PutBucketReplication

  • DeleteBucketReplication

    // Example sending a request using GetBucketReplicationRequest. req := client.GetBucketReplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplication

Example (Shared00)

To get replication configuration set on a bucket

The following example returns replication configuration set on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketReplicationInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketReplicationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketRequestPaymentRequest added in v0.9.0

func (c *Client) GetBucketRequestPaymentRequest(input *GetBucketRequestPaymentInput) GetBucketRequestPaymentRequest

GetBucketRequestPaymentRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html).

The following operations are related to GetBucketRequestPayment:

  • ListObjects

    // Example sending a request using GetBucketRequestPaymentRequest. req := client.GetBucketRequestPaymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment

Example (Shared00)

To get bucket versioning configuration

The following example retrieves bucket versioning configuration.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketRequestPaymentInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketRequestPaymentRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketTaggingRequest added in v0.9.0

func (c *Client) GetBucketTaggingRequest(input *GetBucketTaggingInput) GetBucketTaggingRequest

GetBucketTaggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

  • Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket.

The following operations are related to GetBucketTagging:

  • PutBucketTagging

  • DeleteBucketTagging

    // Example sending a request using GetBucketTaggingRequest. req := client.GetBucketTaggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging

Example (Shared00)

To get tag set associated with a bucket

The following example returns tag set associated with a bucket

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketTaggingInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketVersioningRequest added in v0.9.0

func (c *Client) GetBucketVersioningRequest(input *GetBucketVersioningInput) GetBucketVersioningRequest

GetBucketVersioningRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

  • GetObject

  • PutObject

  • DeleteObject

    // Example sending a request using GetBucketVersioningRequest. req := client.GetBucketVersioningRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning

Example (Shared00)

To get bucket versioning configuration

The following example retrieves bucket versioning configuration.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketVersioningInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketVersioningRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetBucketWebsiteRequest added in v0.9.0

func (c *Client) GetBucketWebsiteRequest(input *GetBucketWebsiteInput) GetBucketWebsiteRequest

GetBucketWebsiteRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).

This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to DeleteBucketWebsite:

  • DeleteBucketWebsite

  • PutBucketWebsite

    // Example sending a request using GetBucketWebsiteRequest. req := client.GetBucketWebsiteRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite

Example (Shared00)

To get bucket website configuration

The following example retrieves website configuration of a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetBucketWebsiteInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.GetBucketWebsiteRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetObjectAclRequest added in v0.9.0

func (c *Client) GetObjectAclRequest(input *GetObjectAclInput) GetObjectAclRequest

GetObjectAclRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

Versioning

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

The following operations are related to GetObjectAcl:

  • GetObject

  • DeleteObject

  • PutObject

    // Example sending a request using GetObjectAclRequest. req := client.GetObjectAclRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAcl

Example (Shared00)

To retrieve object ACL

The following example retrieves access control list (ACL) of an object.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetObjectAclInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.GetObjectAclRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchKey:
				fmt.Println(s3.ErrCodeNoSuchKey, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetObjectLegalHoldRequest added in v0.9.0

func (c *Client) GetObjectLegalHoldRequest(input *GetObjectLegalHoldInput) GetObjectLegalHoldRequest

GetObjectLegalHoldRequest returns a request value for making API operation for Amazon Simple Storage Service.

Gets an object's current Legal Hold status. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).

// Example sending a request using GetObjectLegalHoldRequest.
req := client.GetObjectLegalHoldRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHold

func (*Client) GetObjectLockConfigurationRequest added in v0.9.0

func (c *Client) GetObjectLockConfigurationRequest(input *GetObjectLockConfigurationInput) GetObjectLockConfigurationRequest

GetObjectLockConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).

// Example sending a request using GetObjectLockConfigurationRequest.
req := client.GetObjectLockConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfiguration

func (*Client) GetObjectRequest added in v0.9.0

func (c *Client) GetObjectRequest(input *GetObjectInput) GetObjectRequest

GetObjectRequest returns a request value for making API operation for Amazon Simple Storage Service.

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.

To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket).

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html). For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html).

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side​-encryption​-customer-algorithm

  • x-amz-server-side​-encryption​-customer-key

  • x-amz-server-side​-encryption​-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).

Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error.

  • If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error.

Versioning

By default, the GET operation returns the current version of an object. To return a different version, use the versionId subresource.

If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

For more information about versioning, see PutBucketVersioning.

Overriding Response Header Values

There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.

You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.

You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.

  • response-content-type

  • response-content-language

  • response-expires

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

Additional Considerations about Request Headers

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.

For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232).

The following operations are related to GetObject:

  • ListBuckets

  • GetObjectAcl

    // Example sending a request using GetObjectRequest. req := client.GetObjectRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject

Example (Shared00)

To retrieve a byte range of an object

The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetObjectInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("SampleFile.txt"),
		Range:  aws.String("bytes=0-9"),
	}

	req := svc.GetObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchKey:
				fmt.Println(s3.ErrCodeNoSuchKey, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To retrieve an object

The following example retrieves an object for an S3 bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetObjectInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.GetObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchKey:
				fmt.Println(s3.ErrCodeNoSuchKey, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetObjectRetentionRequest added in v0.9.0

func (c *Client) GetObjectRetentionRequest(input *GetObjectRetentionInput) GetObjectRetentionRequest

GetObjectRetentionRequest returns a request value for making API operation for Amazon Simple Storage Service.

Retrieves an object's retention settings. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).

// Example sending a request using GetObjectRetentionRequest.
req := client.GetObjectRetentionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetention

func (*Client) GetObjectTaggingRequest added in v0.9.0

func (c *Client) GetObjectTaggingRequest(input *GetObjectTaggingInput) GetObjectTaggingRequest

GetObjectTaggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).

The following operation is related to GetObjectTagging:

  • PutObjectTagging

    // Example sending a request using GetObjectTaggingRequest. req := client.GetObjectTaggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging

Example (Shared00)

To retrieve tag set of an object

The following example retrieves tag set of an object.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetObjectTaggingInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.GetObjectTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To retrieve tag set of a specific object version

The following example retrieves tag set of an object. The request specifies object version.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetObjectTaggingInput{
		Bucket:    aws.String("examplebucket"),
		Key:       aws.String("exampleobject"),
		VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"),
	}

	req := svc.GetObjectTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetObjectTorrentRequest added in v0.9.0

func (c *Client) GetObjectTorrentRequest(input *GetObjectTorrentInput) GetObjectTorrentRequest

GetObjectTorrentRequest returns a request value for making API operation for Amazon Simple Storage Service.

Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Amazon S3 Torrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html).

You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key.

To use GET, you must have READ access to the object.

The following operation is related to GetObjectTorrent:

  • GetObject

    // Example sending a request using GetObjectTorrentRequest. req := client.GetObjectTorrentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent

Example (Shared00)

To retrieve torrent files for an object

The following example retrieves torrent files of an object.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.GetObjectTorrentInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.GetObjectTorrentRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) GetPublicAccessBlockRequest added in v0.9.0

func (c *Client) GetPublicAccessBlockRequest(input *GetPublicAccessBlockInput) GetPublicAccessBlockRequest

GetPublicAccessBlockRequest returns a request value for making API operation for Amazon Simple Storage Service.

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).

The following operations are related to GetPublicAccessBlock:

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlock

func (*Client) HeadBucketRequest added in v0.9.0

func (c *Client) HeadBucketRequest(input *HeadBucketInput) HeadBucketRequest

HeadBucketRequest returns a request value for making API operation for Amazon Simple Storage Service.

This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a 200 OK if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as 404 Not Found and 403 Forbidden.

To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

// Example sending a request using HeadBucketRequest.
req := client.HeadBucketRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket

Example (Shared00)

To determine if bucket exists

This operation checks to see if a bucket exists.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.HeadBucketInput{
		Bucket: aws.String("acl1"),
	}

	req := svc.HeadBucketRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchBucket:
				fmt.Println(s3.ErrCodeNoSuchBucket, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) HeadObjectRequest added in v0.9.0

func (c *Client) HeadObjectRequest(input *HeadObjectInput) HeadObjectRequest

HeadObjectRequest returns a request value for making API operation for Amazon Simple Storage Service.

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

  • x-amz-server-side​-encryption​-customer-algorithm

  • x-amz-server-side​-encryption​-customer-key

  • x-amz-server-side​-encryption​-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html).

Consider the following when using request headers:

  • Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested.

  • Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232).

Permissions

You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error.

  • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error.

The following operation is related to HeadObject:

  • GetObject

See http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses for more information on returned errors.

// Example sending a request using HeadObjectRequest.
req := client.HeadObjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject

Example (Shared00)

To retrieve metadata of an object without returning the object itself

The following example retrieves an object metadata.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.HeadObjectInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.HeadObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListBucketAnalyticsConfigurationsRequest added in v0.9.0

func (c *Client) ListBucketAnalyticsConfigurationsRequest(input *ListBucketAnalyticsConfigurationsInput) ListBucketAnalyticsConfigurationsRequest

ListBucketAnalyticsConfigurationsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).

The following operations are related to ListBucketAnalyticsConfigurations:

  • GetBucketAnalyticsConfiguration

  • DeleteBucketAnalyticsConfiguration

  • PutBucketAnalyticsConfiguration

    // Example sending a request using ListBucketAnalyticsConfigurationsRequest. req := client.ListBucketAnalyticsConfigurationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurations

func (*Client) ListBucketInventoryConfigurationsRequest added in v0.9.0

func (c *Client) ListBucketInventoryConfigurationsRequest(input *ListBucketInventoryConfigurationsInput) ListBucketInventoryConfigurationsRequest

ListBucketInventoryConfigurationsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html)

The following operations are related to ListBucketInventoryConfigurations:

  • GetBucketInventoryConfiguration

  • DeleteBucketInventoryConfiguration

  • PutBucketInventoryConfiguration

    // Example sending a request using ListBucketInventoryConfigurationsRequest. req := client.ListBucketInventoryConfigurationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurations

func (*Client) ListBucketMetricsConfigurationsRequest added in v0.9.0

func (c *Client) ListBucketMetricsConfigurationsRequest(input *ListBucketMetricsConfigurationsInput) ListBucketMetricsConfigurationsRequest

ListBucketMetricsConfigurationsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).

The following operations are related to ListBucketMetricsConfigurations:

  • PutBucketMetricsConfiguration

  • GetBucketMetricsConfiguration

  • DeleteBucketMetricsConfiguration

    // Example sending a request using ListBucketMetricsConfigurationsRequest. req := client.ListBucketMetricsConfigurationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurations

func (*Client) ListBucketsRequest added in v0.9.0

func (c *Client) ListBucketsRequest(input *ListBucketsInput) ListBucketsRequest

ListBucketsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns a list of all buckets owned by the authenticated sender of the request.

// Example sending a request using ListBucketsRequest.
req := client.ListBucketsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets

Example (Shared00)

To list object versions

The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListBucketsInput{}

	req := svc.ListBucketsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListMultipartUploadsRequest added in v0.9.0

func (c *Client) ListMultipartUploadsRequest(input *ListMultipartUploadsInput) ListMultipartUploadsRequest

ListMultipartUploadsRequest returns a request value for making API operation for Amazon Simple Storage Service.

This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html).

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).

The following operations are related to ListMultipartUploads:

  • CreateMultipartUpload

  • UploadPart

  • CompleteMultipartUpload

  • ListParts

  • AbortMultipartUpload

    // Example sending a request using ListMultipartUploadsRequest. req := client.ListMultipartUploadsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads

Example (Shared00)

List next set of multipart uploads when previous result is truncated

The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListMultipartUploadsInput{
		Bucket:         aws.String("examplebucket"),
		KeyMarker:      aws.String("nextkeyfrompreviousresponse"),
		MaxUploads:     aws.Int64(2),
		UploadIdMarker: aws.String("valuefrompreviousresponse"),
	}

	req := svc.ListMultipartUploadsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To list in-progress multipart uploads on a bucket

The following example lists in-progress multipart uploads on a specific bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListMultipartUploadsInput{
		Bucket: aws.String("examplebucket"),
	}

	req := svc.ListMultipartUploadsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListObjectVersionsRequest added in v0.9.0

func (c *Client) ListObjectVersionsRequest(input *ListObjectVersionsInput) ListObjectVersionsRequest

ListObjectVersionsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

The following operations are related to ListObjectVersions:

  • ListObjectsV2

  • GetObject

  • PutObject

  • DeleteObject

    // Example sending a request using ListObjectVersionsRequest. req := client.ListObjectVersionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions

Example (Shared00)

To list object versions

The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListObjectVersionsInput{
		Bucket: aws.String("examplebucket"),
		Prefix: aws.String("HappyFace.jpg"),
	}

	req := svc.ListObjectVersionsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListObjectsRequest added in v0.9.0

func (c *Client) ListObjectsRequest(input *ListObjectsInput) ListObjectsRequest

ListObjectsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

  • ListObjectsV2

  • GetObject

  • PutObject

  • CreateBucket

  • ListBuckets

    // Example sending a request using ListObjectsRequest. req := client.ListObjectsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects

Example (Shared00)

To list objects in a bucket

The following example list two objects in a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListObjectsInput{
		Bucket:  aws.String("examplebucket"),
		MaxKeys: aws.Int64(2),
	}

	req := svc.ListObjectsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchBucket:
				fmt.Println(s3.ErrCodeNoSuchBucket, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListObjectsV2Request added in v0.9.0

func (c *Client) ListObjectsV2Request(input *ListObjectsV2Input) ListObjectsV2Request

ListObjectsV2Request returns a request value for making API operation for Amazon Simple Storage Service.

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

  • GetObject

  • PutObject

  • CreateBucket

    // Example sending a request using ListObjectsV2Request. req := client.ListObjectsV2Request(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2

Example (Shared00)

To get object list

The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListObjectsV2Input{
		Bucket:  aws.String("examplebucket"),
		MaxKeys: aws.Int64(2),
	}

	req := svc.ListObjectsV2Request(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchBucket:
				fmt.Println(s3.ErrCodeNoSuchBucket, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListPartsRequest added in v0.9.0

func (c *Client) ListPartsRequest(input *ListPartsInput) ListPartsRequest

ListPartsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html).

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).

The following operations are related to ListParts:

  • CreateMultipartUpload

  • UploadPart

  • CompleteMultipartUpload

  • AbortMultipartUpload

  • ListMultipartUploads

    // Example sending a request using ListPartsRequest. req := client.ListPartsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts

Example (Shared00)

To list parts of a multipart upload.

The following example lists parts uploaded for a specific multipart upload.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.ListPartsInput{
		Bucket:   aws.String("examplebucket"),
		Key:      aws.String("bigobject"),
		UploadId: aws.String("example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"),
	}

	req := svc.ListPartsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketAccelerateConfigurationRequest added in v0.9.0

func (c *Client) PutBucketAccelerateConfigurationRequest(input *PutBucketAccelerateConfigurationInput) PutBucketAccelerateConfigurationRequest

PutBucketAccelerateConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

The Transfer Acceleration state of a bucket can be set to one of the following two values:

  • Enabled – Enables accelerated data transfers to the bucket.

  • Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).

The following operations are related to PutBucketAccelerateConfiguration:

  • GetBucketAccelerateConfiguration

  • CreateBucket

    // Example sending a request using PutBucketAccelerateConfigurationRequest. req := client.PutBucketAccelerateConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfiguration

func (*Client) PutBucketAclRequest added in v0.9.0

func (c *Client) PutBucketAclRequest(input *PutBucketAclInput) PutBucketAclRequest

PutBucketAclRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

  • Specify the ACL in the request body

  • Specify permissions using request headers

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

Access Permissions

You can set access permissions using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses. x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Related Resources

  • CreateBucket

  • DeleteBucket

  • GetObjectAcl

    // Example sending a request using PutBucketAclRequest. req := client.PutBucketAclRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl

Example (Shared00)

Put bucket acl

The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketAclInput{
		Bucket:           aws.String("examplebucket"),
		GrantFullControl: aws.String("id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484"),
		GrantWrite:       aws.String("uri=http://acs.amazonaws.com/groups/s3/LogDelivery"),
	}

	req := svc.PutBucketAclRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketAnalyticsConfigurationRequest added in v0.9.0

func (c *Client) PutBucketAnalyticsConfigurationRequest(input *PutBucketAnalyticsConfigurationInput) PutBucketAnalyticsConfigurationRequest

PutBucketAnalyticsConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

Special Errors

  • HTTP Error: HTTP 400 Bad Request Code: InvalidArgument Cause: Invalid argument.

  • HTTP Error: HTTP 400 Bad Request Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

  • HTTP Error: HTTP 403 Forbidden Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

Related Resources

*

*

*

// Example sending a request using PutBucketAnalyticsConfigurationRequest.
req := client.PutBucketAnalyticsConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfiguration

func (*Client) PutBucketCorsRequest added in v0.9.0

func (c *Client) PutBucketCorsRequest(input *PutBucketCorsInput) PutBucketCorsRequest

PutBucketCorsRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

  • The request's Origin header must match AllowedOrigin elements.

  • The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.

  • Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon Simple Storage Service Developer Guide.

Related Resources

  • GetBucketCors

  • DeleteBucketCors

  • RESTOPTIONSobject

    // Example sending a request using PutBucketCorsRequest. req := client.PutBucketCorsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors

Example (Shared00)

To set cors configuration on a bucket.

The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketCorsInput{
		Bucket: aws.String(""),
		CORSConfiguration: &s3.CORSConfiguration{
			CORSRules: []s3.CORSRule{
				{
					AllowedHeaders: []string{
						"*",
					},
					AllowedMethods: []string{
						"PUT",
						"POST",
						"DELETE",
					},
					AllowedOrigins: []string{
						"http://www.example.com",
					},
					ExposeHeaders: []string{
						"x-amz-server-side-encryption",
					},
					MaxAgeSeconds: aws.Int64(3000),
				},
				{
					AllowedHeaders: []string{
						"Authorization",
					},
					AllowedMethods: []string{
						"GET",
					},
					AllowedOrigins: []string{
						"*",
					},
					MaxAgeSeconds: aws.Int64(3000),
				},
			},
		},
	}

	req := svc.PutBucketCorsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketEncryptionRequest added in v0.9.0

func (c *Client) PutBucketEncryptionRequest(input *PutBucketEncryptionInput) PutBucketEncryptionRequest

PutBucketEncryptionRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the PUT operation uses the encryption subresource to set the default encryption state of an existing bucket.

This implementation of the PUT operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html).

This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4) (sig-v4-authenticating-requests.html).

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

Related Resources

  • GetBucketEncryption

  • DeleteBucketEncryption

    // Example sending a request using PutBucketEncryptionRequest. req := client.PutBucketEncryptionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryption

func (*Client) PutBucketInventoryConfigurationRequest added in v0.9.0

func (c *Client) PutBucketInventoryConfigurationRequest(input *PutBucketInventoryConfigurationInput) PutBucketInventoryConfigurationRequest

PutBucketInventoryConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

This implementation of the PUT operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) in the Amazon Simple Storage Service Developer Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

Special Errors

  • HTTP 400 Bad Request Error Code: InvalidArgument Cause: Invalid Argument

  • HTTP 400 Bad Request Error Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

  • HTTP 403 Forbidden Error Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

Related Resources

  • GetBucketInventoryConfiguration

  • DeleteBucketInventoryConfiguration

  • ListBucketInventoryConfigurations

    // Example sending a request using PutBucketInventoryConfigurationRequest. req := client.PutBucketInventoryConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfiguration

func (*Client) PutBucketLifecycleConfigurationRequest added in v0.9.0

func (c *Client) PutBucketLifecycleConfigurationRequest(input *PutBucketLifecycleConfigurationInput) PutBucketLifecycleConfigurationRequest

PutBucketLifecycleConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

  • Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.

  • Status whether the rule is in effect.

  • One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) and Lifecycle Configuration Elements (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html).

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

The following are related to PutBucketLifecycleConfiguration:

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration

Example (Shared00)

Put bucket lifecycle

The following example replaces existing lifecycle configuration, if any, on the specified bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketLifecycleConfigurationInput{
		Bucket: aws.String("examplebucket"),
		LifecycleConfiguration: &s3.BucketLifecycleConfiguration{
			Rules: []s3.LifecycleRule{
				{
					Expiration: &s3.LifecycleExpiration{
						Days: aws.Int64(3650),
					},
					Filter: &s3.LifecycleRuleFilter{
						Prefix: aws.String("documents/"),
					},
					ID:     aws.String("TestOnly"),
					Status: s3.ExpirationStatusEnabled,
					Transitions: []s3.Transition{
						{
							Days:         aws.Int64(365),
							StorageClass: s3.TransitionStorageClassGlacier,
						},
					},
				},
			},
		},
	}

	req := svc.PutBucketLifecycleConfigurationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketLifecycleRequest added in v0.9.0

func (c *Client) PutBucketLifecycleRequest(input *PutBucketLifecycleInput) PutBucketLifecycleRequest

PutBucketLifecycleRequest returns a request value for making API operation for Amazon Simple Storage Service.

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the Amazon Simple Storage Service Developer Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples).

Related Resources

  • GetBucketLifecycle(Deprecated)

  • GetBucketLifecycleConfiguration

    *

  • By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide: Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)

    // Example sending a request using PutBucketLifecycleRequest. req := client.PutBucketLifecycleRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycle

func (*Client) PutBucketLoggingRequest added in v0.9.0

func (c *Client) PutBucketLoggingRequest(input *PutBucketLoggingInput) PutBucketLoggingRequest

PutBucketLoggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more information about server access logging, see Server Access Logging (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html).

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

  • PutObject

  • DeleteBucket

  • CreateBucket

  • GetBucketLogging

    // Example sending a request using PutBucketLoggingRequest. req := client.PutBucketLoggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging

Example (Shared00)

Set logging configuration for a bucket

The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketLoggingInput{
		Bucket: aws.String("sourcebucket"),
		BucketLoggingStatus: &s3.BucketLoggingStatus{
			LoggingEnabled: &s3.LoggingEnabled{
				TargetBucket: aws.String("targetbucket"),
				TargetGrants: []s3.TargetGrant{
					{
						Grantee: &s3.Grantee{
							Type: s3.TypeGroup,
							URI:  aws.String("http://acs.amazonaws.com/groups/global/AllUsers"),
						},
						Permission: s3.BucketLogsPermissionRead,
					},
				},
				TargetPrefix: aws.String("MyBucketLogs/"),
			},
		},
	}

	req := svc.PutBucketLoggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketMetricsConfigurationRequest added in v0.9.0

func (c *Client) PutBucketMetricsConfigurationRequest(input *PutBucketMetricsConfigurationInput) PutBucketMetricsConfigurationRequest

PutBucketMetricsConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).

The following operations are related to PutBucketMetricsConfiguration:

  • DeleteBucketMetricsConfiguration

  • PutBucketMetricsConfiguration

  • ListBucketMetricsConfigurations

GetBucketLifecycle has the following special error:

  • Error code: TooManyConfigurations Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Status Code: HTTP 400 Bad Request

    // Example sending a request using PutBucketMetricsConfigurationRequest. req := client.PutBucketMetricsConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfiguration

func (*Client) PutBucketNotificationConfigurationRequest added in v0.9.0

func (c *Client) PutBucketNotificationConfigurationRequest(input *PutBucketNotificationConfigurationInput) PutBucketNotificationConfigurationRequest

PutBucketNotificationConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This operation replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).

You can disable notifications by adding the empty NotificationConfiguration element.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.

Responses

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following operation is related to PutBucketNotificationConfiguration:

  • GetBucketNotificationConfiguration

    // Example sending a request using PutBucketNotificationConfigurationRequest. req := client.PutBucketNotificationConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfiguration

Example (Shared00)

Set notification configuration for a bucket

The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketNotificationConfigurationInput{
		Bucket: aws.String("examplebucket"),
		NotificationConfiguration: &s3.NotificationConfiguration{
			TopicConfigurations: []s3.TopicConfiguration{
				{
					Events: []s3.Event{
						s3.EventS3ObjectCreated,
					},
					TopicArn: aws.String("arn:aws:sns:us-west-2:123456789012:s3-notification-topic"),
				},
			},
		},
	}

	req := svc.PutBucketNotificationConfigurationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketNotificationRequest added in v0.9.0

func (c *Client) PutBucketNotificationRequest(input *PutBucketNotificationInput) PutBucketNotificationRequest

PutBucketNotificationRequest returns a request value for making API operation for Amazon Simple Storage Service.

No longer used, see the PutBucketNotificationConfiguration operation.

// Example sending a request using PutBucketNotificationRequest.
req := client.PutBucketNotificationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotification

func (*Client) PutBucketPolicyRequest added in v0.9.0

func (c *Client) PutBucketPolicyRequest(input *PutBucketPolicyInput) PutBucketPolicyRequest

PutBucketPolicyRequest returns a request value for making API operation for Amazon Simple Storage Service.

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

The following operations are related to PutBucketPolicy:

  • CreateBucket

  • DeleteBucket

    // Example sending a request using PutBucketPolicyRequest. req := client.PutBucketPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy

Example (Shared00)

Set bucket policy

The following example sets a permission policy on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketPolicyInput{
		Bucket: aws.String("examplebucket"),
		Policy: aws.String("{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}"),
	}

	req := svc.PutBucketPolicyRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketReplicationRequest added in v0.9.0

func (c *Client) PutBucketReplicationRequest(input *PutBucketReplicationInput) PutBucketReplicationRequest

PutBucketReplicationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Creates a replication configuration or replaces an existing one. For more information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon S3 Developer Guide.

To perform this operation, the user or role performing the operation must have the iam:PassRole (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) permission.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.

To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

For information about enabling versioning on a bucket, see Using Versioning (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).

By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html).

For information on PutBucketReplication errors, see ReplicationErrorCodeList

The following operations are related to PutBucketReplication:

  • GetBucketReplication

  • DeleteBucketReplication

    // Example sending a request using PutBucketReplicationRequest. req := client.PutBucketReplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplication

Example (Shared00)

Set replication configuration on a bucket

The following example sets replication configuration on a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketReplicationInput{
		Bucket: aws.String("examplebucket"),
		ReplicationConfiguration: &s3.ReplicationConfiguration{
			Role: aws.String("arn:aws:iam::123456789012:role/examplerole"),
			Rules: []s3.ReplicationRule{
				{
					Destination: &s3.Destination{
						Bucket:       aws.String("arn:aws:s3:::destinationbucket"),
						StorageClass: s3.StorageClassStandard,
					},
					Prefix: aws.String(""),
					Status: s3.ReplicationRuleStatusEnabled,
				},
			},
		},
	}

	req := svc.PutBucketReplicationRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketRequestPaymentRequest added in v0.9.0

func (c *Client) PutBucketRequestPaymentRequest(input *PutBucketRequestPaymentInput) PutBucketRequestPaymentRequest

PutBucketRequestPaymentRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html).

The following operations are related to PutBucketRequestPayment:

  • CreateBucket

  • GetBucketRequestPayment

    // Example sending a request using PutBucketRequestPaymentRequest. req := client.PutBucketRequestPaymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment

Example (Shared00)

Set request payment configuration on a bucket.

The following example sets request payment configuration on a bucket so that person requesting the download is charged.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketRequestPaymentInput{
		Bucket: aws.String("examplebucket"),
		RequestPaymentConfiguration: &s3.RequestPaymentConfiguration{
			Payer: s3.PayerRequester,
		},
	}

	req := svc.PutBucketRequestPaymentRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketTaggingRequest added in v0.9.0

func (c *Client) PutBucketTaggingRequest(input *PutBucketTaggingInput) PutBucketTaggingRequest

PutBucketTaggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html).

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html).

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

PutBucketTagging has the following special errors:

The following operations are related to PutBucketTagging:

  • GetBucketTagging

  • DeleteBucketTagging

    // Example sending a request using PutBucketTaggingRequest. req := client.PutBucketTaggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging

Example (Shared00)

Set tags on a bucket

The following example sets tags on a bucket. Any existing tags are replaced.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketTaggingInput{
		Bucket: aws.String("examplebucket"),
		Tagging: &s3.Tagging{
			TagSet: []s3.Tag{
				{
					Key:   aws.String("Key1"),
					Value: aws.String("Value1"),
				},
				{
					Key:   aws.String("Key2"),
					Value: aws.String("Value2"),
				},
			},
		},
	}

	req := svc.PutBucketTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketVersioningRequest added in v0.9.0

func (c *Client) PutBucketVersioningRequest(input *PutBucketVersioningInput) PutBucketVersioningRequest

PutBucketVersioningRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config).

Related Resources

  • CreateBucket

  • DeleteBucket

  • GetBucketVersioning

    // Example sending a request using PutBucketVersioningRequest. req := client.PutBucketVersioningRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioning

Example (Shared00)

Set versioning configuration on a bucket

The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketVersioningInput{
		Bucket: aws.String("examplebucket"),
		VersioningConfiguration: &s3.VersioningConfiguration{
			MFADelete: s3.MFADeleteDisabled,
			Status:    s3.BucketVersioningStatusEnabled,
		},
	}

	req := svc.PutBucketVersioningRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutBucketWebsiteRequest added in v0.9.0

func (c *Client) PutBucketWebsiteRequest(input *PutBucketWebsiteInput) PutBucketWebsiteRequest

PutBucketWebsiteRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).

This PUT operation requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.

  • WebsiteConfiguration

  • RedirectAllRequestsTo

  • HostName

  • Protocol

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

  • WebsiteConfiguration

  • IndexDocument

  • Suffix

  • ErrorDocument

  • Key

  • RoutingRules

  • RoutingRule

  • Condition

  • HttpErrorCodeReturnedEquals

  • KeyPrefixEquals

  • Redirect

  • Protocol

  • HostName

  • ReplaceKeyPrefixWith

  • ReplaceKeyWith

  • HttpRedirectCode

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in the Amazon Simple Storage Service Developer Guide.

// Example sending a request using PutBucketWebsiteRequest.
req := client.PutBucketWebsiteRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite

Example (Shared00)

Set website configuration on a bucket

The following example adds website configuration to a bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutBucketWebsiteInput{
		Bucket: aws.String("examplebucket"),
		WebsiteConfiguration: &s3.WebsiteConfiguration{
			ErrorDocument: &s3.ErrorDocument{
				Key: aws.String("error.html"),
			},
			IndexDocument: &s3.IndexDocument{
				Suffix: aws.String("index.html"),
			},
		},
	}

	req := svc.PutBucketWebsiteRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutObjectAclRequest added in v0.9.0

func (c *Client) PutObjectAclRequest(input *PutObjectAclInput) PutObjectAclRequest

PutObjectAclRequest returns a request value for making API operation for Amazon Simple Storage Service.

Uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP permission to set the ACL of an object.

Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the Amazon S3 Developer Guide.

Access Permissions

You can set access permissions using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. For example, the following x-amz-grant-read header grants list objects permission to the two AWS accounts identified by their email addresses. x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Versioning

The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

Related Resources

  • CopyObject

  • GetObject

    // Example sending a request using PutObjectAclRequest. req := client.PutObjectAclRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAcl

Example (Shared00)

To grant permissions using object ACL

The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectAclInput{
		AccessControlPolicy: &s3.AccessControlPolicy{},
		Bucket:              aws.String("examplebucket"),
		GrantFullControl:    aws.String("emailaddress=user1@example.com,emailaddress=user2@example.com"),
		GrantRead:           aws.String("uri=http://acs.amazonaws.com/groups/global/AllUsers"),
		Key:                 aws.String("HappyFace.jpg"),
	}

	req := svc.PutObjectAclRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeNoSuchKey:
				fmt.Println(s3.ErrCodeNoSuchKey, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutObjectLegalHoldRequest added in v0.9.0

func (c *Client) PutObjectLegalHoldRequest(input *PutObjectLegalHoldInput) PutObjectLegalHoldRequest

PutObjectLegalHoldRequest returns a request value for making API operation for Amazon Simple Storage Service.

Applies a Legal Hold configuration to the specified object.

Related Resources

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHold

func (*Client) PutObjectLockConfigurationRequest added in v0.9.0

func (c *Client) PutObjectLockConfigurationRequest(input *PutObjectLockConfigurationInput) PutObjectLockConfigurationRequest

PutObjectLockConfigurationRequest returns a request value for making API operation for Amazon Simple Storage Service.

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

DefaultRetention requires either Days or Years. You can't specify both at the same time.

Related Resources

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration

func (*Client) PutObjectRequest added in v0.9.0

func (c *Client) PutObjectRequest(input *PutObjectInput) PutObjectRequest

PutObjectRequest returns a request value for making API operation for Amazon Simple Storage Service.

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) in the Amazon Simple Storage Service Developer Guide.

Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html).

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing ACLs Using the REST API (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html).

Storage Class Options

By default, Amazon S3 uses the STANDARD storage class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different storage class. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the Amazon S3 Service Developer Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

For more information about versioning, see Adding Objects to Versioning Enabled Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html). For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

  • CopyObject

  • DeleteObject

    // Example sending a request using PutObjectRequest. req := client.PutObjectRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject

Example (Shared00)

To upload an object and specify server-side encryption and object tags

The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		Body:                 aws.ReadSeekCloser(strings.NewReader("filetoupload")),
		Bucket:               aws.String("examplebucket"),
		Key:                  aws.String("exampleobject"),
		ServerSideEncryption: s3.ServerSideEncryptionAes256,
		Tagging:              aws.String("key1=value1&key2=value2"),
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To create an object.

The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		Body:   aws.ReadSeekCloser(strings.NewReader("filetoupload")),
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("objectkey"),
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared02)

To upload an object and specify optional tags

The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		Body:    aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")),
		Bucket:  aws.String("examplebucket"),
		Key:     aws.String("HappyFace.jpg"),
		Tagging: aws.String("key1=value1&key2=value2"),
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared03)

To upload an object (specify optional headers)

The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		Body:                 aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")),
		Bucket:               aws.String("examplebucket"),
		Key:                  aws.String("HappyFace.jpg"),
		ServerSideEncryption: s3.ServerSideEncryptionAes256,
		StorageClass:         s3.StorageClassStandardIa,
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared04)

To upload object and specify user-defined metadata

The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		Body:   aws.ReadSeekCloser(strings.NewReader("filetoupload")),
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("exampleobject"),
		Metadata: map[string]string{
			"metadata1": "value1",
			"metadata2": "value2",
		},
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared05)

To upload an object and specify canned ACL.

The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		ACL:    s3.ObjectCannedACLAuthenticatedRead,
		Body:   aws.ReadSeekCloser(strings.NewReader("filetoupload")),
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("exampleobject"),
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared06)

To upload an object

The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectInput{
		Body:   aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")),
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
	}

	req := svc.PutObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutObjectRetentionRequest added in v0.9.0

func (c *Client) PutObjectRetentionRequest(input *PutObjectRetentionInput) PutObjectRetentionRequest

PutObjectRetentionRequest returns a request value for making API operation for Amazon Simple Storage Service.

Places an Object Retention configuration on an object.

Related Resources

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetention

func (*Client) PutObjectTaggingRequest added in v0.9.0

func (c *Client) PutObjectTaggingRequest(input *PutObjectTaggingInput) PutObjectTaggingRequest

PutObjectTaggingRequest returns a request value for making API operation for Amazon Simple Storage Service.

Sets the supplied tag-set to an object that already exists in a bucket.

A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html). Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

For information about the Amazon S3 object tagging feature, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).

Special Errors

  • Code: InvalidTagError Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).

  • Code: MalformedXMLError Cause: The XML provided does not match the schema.

  • Code: OperationAbortedError Cause: A conflicting conditional operation is currently in progress against this resource. Please try again.

  • Code: InternalError Cause: The service was unable to apply the provided tag to the object.

Related Resources

  • GetObjectTagging

    // Example sending a request using PutObjectTaggingRequest. req := client.PutObjectTaggingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging

Example (Shared00)

To add tags to an existing object

The following example adds tags to an existing object.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.PutObjectTaggingInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("HappyFace.jpg"),
		Tagging: &s3.Tagging{
			TagSet: []s3.Tag{
				{
					Key:   aws.String("Key3"),
					Value: aws.String("Value3"),
				},
				{
					Key:   aws.String("Key4"),
					Value: aws.String("Value4"),
				},
			},
		},
	}

	req := svc.PutObjectTaggingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) PutPublicAccessBlockRequest added in v0.9.0

func (c *Client) PutPublicAccessBlockRequest(input *PutPublicAccessBlockInput) PutPublicAccessBlockRequest

PutPublicAccessBlockRequest returns a request value for making API operation for Amazon Simple Storage Service.

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).

Related Resources

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlock

func (*Client) RestoreObjectRequest added in v0.9.0

func (c *Client) RestoreObjectRequest(input *RestoreObjectInput) RestoreObjectRequest

RestoreObjectRequest returns a request value for making API operation for Amazon Simple Storage Service.

Restores an archived copy of an object back into Amazon S3

This operation performs the following types of requests:

  • select - Perform a select query on an archived object

  • restore an archive - Restore an archived object

To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) in the Amazon Simple Storage Service Developer Guide.

Querying Archives with Select Requests

You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html) in the Amazon Simple Storage Service Developer Guide.

When making a select request, do the following:

  • Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html) in the Amazon Simple Storage Service Developer Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) in the Amazon Simple Storage Service Developer Guide Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) in the Amazon Simple Storage Service Developer Guide

  • Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html) in the Amazon Simple Storage Service Developer Guide.

When making a select request, you can also do the following:

  • To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic.

  • Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

  • The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.

  • You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.

  • Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Restoring Archives

Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify.

When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:

  • Expedited - Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class.

  • Standard - S3 Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. S3 Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class.

  • Bulk - Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) in the Amazon Simple Storage Service Developer Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days request element. For more information, see Upgrading the Speed of an In-Progress Restore (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html) in the Amazon Simple Storage Service Developer Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the Amazon Simple Storage Service Developer Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in Amazon Simple Storage Service Developer Guide.

Responses

A successful operation returns either the 200 OK or 202 Accepted status code.

  • If the object copy is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object copy is previously restored, Amazon S3 returns 200 OK in the response.

Special Errors

  • Code: RestoreAlreadyInProgress Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client

  • Code: GlacierExpeditedRetrievalNotAvailable Cause: S3 Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A

Related Resources

  • PutBucketLifecycleConfiguration

  • GetBucketNotificationConfiguration

  • SQL Reference for Amazon S3 Select and S3 Glacier Select (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html) in the Amazon Simple Storage Service Developer Guide

    // Example sending a request using RestoreObjectRequest. req := client.RestoreObjectRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject

Example (Shared00)

To restore an archived object

The following example restores for one day an archived copy of an object back into Amazon S3 bucket.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.RestoreObjectInput{
		Bucket: aws.String("examplebucket"),
		Key:    aws.String("archivedobjectkey"),
		RestoreRequest: &s3.RestoreRequest{
			Days: aws.Int64(1),
			GlacierJobParameters: &s3.GlacierJobParameters{
				Tier: s3.TierExpedited,
			},
		},
	}

	req := svc.RestoreObjectRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case s3.ErrCodeObjectAlreadyInActiveTierError:
				fmt.Println(s3.ErrCodeObjectAlreadyInActiveTierError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) UploadPartCopyRequest added in v0.9.0

func (c *Client) UploadPartCopyRequest(input *UploadPartCopyInput) UploadPartCopyRequest

UploadPartCopyRequest returns a request value for making API operation for Amazon Simple Storage Service.

Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.

The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts (https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html) in the Amazon Simple Storage Service Developer Guide.

Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.

For more information about using the UploadPartCopy operation, see the following:

Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:

  • Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true, and; x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200 OK and copies the data.

  • Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows: x-amz-copy-source-if-none-match condition evaluates to false, and; x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412 Precondition Failed response code.

Versioning

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example:

x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

  • Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found

  • Code: InvalidRequest Cause: The specified copy source is not supported as a byte-range copy source. HTTP Status Code: 400 Bad Request

Related Resources

  • CreateMultipartUpload

  • UploadPart

  • CompleteMultipartUpload

  • AbortMultipartUpload

  • ListParts

  • ListMultipartUploads

    // Example sending a request using UploadPartCopyRequest. req := client.UploadPartCopyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy

Example (Shared00)

To upload a part by copying data from an existing object as data source

The following example uploads a part of a multipart upload by copying data from an existing object as data source.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.UploadPartCopyInput{
		Bucket:     aws.String("examplebucket"),
		CopySource: aws.String("/bucketname/sourceobjectkey"),
		Key:        aws.String("examplelargeobject"),
		PartNumber: aws.Int64(1),
		UploadId:   aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"),
	}

	req := svc.UploadPartCopyRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

To upload a part by copying byte range from an existing object as data source

The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.UploadPartCopyInput{
		Bucket:          aws.String("examplebucket"),
		CopySource:      aws.String("/bucketname/sourceobjectkey"),
		CopySourceRange: aws.String("bytes=1-100000"),
		Key:             aws.String("examplelargeobject"),
		PartNumber:      aws.Int64(2),
		UploadId:        aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"),
	}

	req := svc.UploadPartCopyRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) UploadPartRequest added in v0.9.0

func (c *Client) UploadPartRequest(input *UploadPartInput) UploadPartRequest

UploadPartRequest returns a request value for making API operation for Amazon Simple Storage Service.

Uploads a part in a multipart upload.

In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.

To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

For more information on multipart uploads, go to Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) in the Amazon Simple Storage Service Developer Guide .

For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) in the Amazon Simple Storage Service Developer Guide.

You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the Amazon Simple Storage Service Developer Guide.

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.

If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.

  • x-amz-server-side​-encryption​-customer-algorithm

  • x-amz-server-side​-encryption​-customer-key

  • x-amz-server-side​-encryption​-customer-key-MD5

Special Errors

  • Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client

Related Resources

  • CreateMultipartUpload

  • CompleteMultipartUpload

  • AbortMultipartUpload

  • ListParts

  • ListMultipartUploads

    // Example sending a request using UploadPartRequest. req := client.UploadPartRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart

Example (Shared00)

To upload a part

The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.

package main

import (
	"context"
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := s3.New(cfg)
	input := &s3.UploadPartInput{
		Body:       aws.ReadSeekCloser(strings.NewReader("fileToUpload")),
		Bucket:     aws.String("examplebucket"),
		Key:        aws.String("examplelargeobject"),
		PartNumber: aws.Int64(1),
		UploadId:   aws.String("xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"),
	}

	req := svc.UploadPartRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) WaitUntilBucketExists added in v0.9.0

func (c *Client) WaitUntilBucketExists(ctx context.Context, input *HeadBucketInput, opts ...aws.WaiterOption) error

WaitUntilBucketExists uses the Amazon S3 API operation HeadBucket to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilBucketNotExists added in v0.9.0

func (c *Client) WaitUntilBucketNotExists(ctx context.Context, input *HeadBucketInput, opts ...aws.WaiterOption) error

WaitUntilBucketNotExists uses the Amazon S3 API operation HeadBucket to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilObjectExists added in v0.9.0

func (c *Client) WaitUntilObjectExists(ctx context.Context, input *HeadObjectInput, opts ...aws.WaiterOption) error

WaitUntilObjectExists uses the Amazon S3 API operation HeadObject to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilObjectNotExists added in v0.9.0

func (c *Client) WaitUntilObjectNotExists(ctx context.Context, input *HeadObjectInput, opts ...aws.WaiterOption) error

WaitUntilObjectNotExists uses the Amazon S3 API operation HeadObject to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CloudFunctionConfiguration

type CloudFunctionConfiguration struct {

	// Lambda cloud function ARN that Amazon S3 can invoke when it detects events
	// of the specified type.
	CloudFunction *string `type:"string"`

	// The bucket event for which to send notifications.
	Event Event `deprecated:"true" type:"string" enum:"true"`

	// Bucket events for which to send notifications.
	Events []Event `locationName:"Event" type:"list" flattened:"true"`

	// An optional unique identifier for configurations in a notification configuration.
	// If you don't provide one, Amazon S3 will assign an ID.
	Id *string `type:"string"`

	// The role supporting the invocation of the Lambda function
	InvocationRole *string `type:"string"`
	// contains filtered or unexported fields
}

Container for specifying the AWS Lambda notification configuration.

func (CloudFunctionConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CloudFunctionConfiguration) String

String returns the string representation

type CommonPrefix

type CommonPrefix struct {

	// Container for the specified common prefix.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

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/.

func (CommonPrefix) MarshalFields added in v0.3.0

func (s CommonPrefix) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CommonPrefix) String

func (s CommonPrefix) String() string

String returns the string representation

type CompleteMultipartUploadInput

type CompleteMultipartUploadInput struct {

	// Name of the bucket to which the multipart upload was initiated.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Object key for which the multipart upload was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// The container for the multipart upload request information.
	MultipartUpload *CompletedMultipartUpload `locationName:"CompleteMultipartUpload" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// ID for the initiated multipart upload.
	//
	// UploadId is a required field
	UploadId *string `location:"querystring" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CompleteMultipartUploadInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CompleteMultipartUploadInput) String

String returns the string representation

func (*CompleteMultipartUploadInput) Validate

func (s *CompleteMultipartUploadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CompleteMultipartUploadOutput

type CompleteMultipartUploadOutput struct {

	// The name of the bucket that contains the newly created object.
	Bucket *string `type:"string"`

	// Entity tag that identifies the newly created object's data. Objects with
	// different object data will have different entity tags. The entity tag is
	// an opaque string. The entity tag may or may not be an MD5 digest of the object
	// data. If the entity tag is not an MD5 digest of the object data, it will
	// contain one or more nonhexadecimal characters and/or will consist of less
	// than 32 or more than 32 hexadecimal digits.
	ETag *string `type:"string"`

	// If the object expiration is configured, this will contain the expiration
	// date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
	Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`

	// The object key of the newly created object.
	Key *string `min:"1" type:"string"`

	// The URI that identifies the newly created object.
	Location *string `type:"string"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// If you specified server-side encryption either with an Amazon S3-managed
	// encryption key or an AWS KMS customer master key (CMK) in your initiate multipart
	// upload request, the response includes this header. It confirms the encryption
	// algorithm that Amazon S3 used to encrypt the object.
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// Version ID of the newly created object, in case the bucket has versioning
	// turned on.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (CompleteMultipartUploadOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CompleteMultipartUploadOutput) String

String returns the string representation

type CompleteMultipartUploadRequest

type CompleteMultipartUploadRequest struct {
	*aws.Request
	Input *CompleteMultipartUploadInput
	Copy  func(*CompleteMultipartUploadInput) CompleteMultipartUploadRequest
}

CompleteMultipartUploadRequest is the request type for the CompleteMultipartUpload API operation.

func (CompleteMultipartUploadRequest) Send

Send marshals and sends the CompleteMultipartUpload API request.

type CompleteMultipartUploadResponse added in v0.9.0

type CompleteMultipartUploadResponse struct {
	*CompleteMultipartUploadOutput
	// contains filtered or unexported fields
}

CompleteMultipartUploadResponse is the response type for the CompleteMultipartUpload API operation.

func (*CompleteMultipartUploadResponse) SDKResponseMetdata added in v0.9.0

func (r *CompleteMultipartUploadResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CompleteMultipartUpload request.

type CompletedMultipartUpload

type CompletedMultipartUpload struct {

	// Array of CompletedPart data types.
	Parts []CompletedPart `locationName:"Part" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

The container for the completed multipart upload details.

func (CompletedMultipartUpload) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CompletedMultipartUpload) String

func (s CompletedMultipartUpload) String() string

String returns the string representation

type CompletedPart

type CompletedPart struct {

	// Entity tag returned when the part was uploaded.
	ETag *string `type:"string"`

	// Part number that identifies the part. This is a positive integer between
	// 1 and 10,000.
	PartNumber *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Details of the parts that were uploaded.

func (CompletedPart) MarshalFields added in v0.3.0

func (s CompletedPart) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CompletedPart) String

func (s CompletedPart) String() string

String returns the string representation

type CompressionType added in v0.4.0

type CompressionType string
const (
	CompressionTypeNone  CompressionType = "NONE"
	CompressionTypeGzip  CompressionType = "GZIP"
	CompressionTypeBzip2 CompressionType = "BZIP2"
)

Enum values for CompressionType

func (CompressionType) MarshalValue added in v0.4.0

func (enum CompressionType) MarshalValue() (string, error)

func (CompressionType) MarshalValueBuf added in v0.4.0

func (enum CompressionType) MarshalValueBuf(b []byte) ([]byte, error)

type Condition

type Condition struct {

	// The HTTP error code when the redirect is applied. In the event of an error,
	// if the error code equals this value, then the specified redirect is applied.
	// Required when parent element Condition is specified and sibling KeyPrefixEquals
	// is not specified. If both are specified, then both must be true for the redirect
	// to be applied.
	HttpErrorCodeReturnedEquals *string `type:"string"`

	// The object key name prefix when the redirect is applied. For example, to
	// redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html.
	// To redirect request for all pages with the prefix docs/, the key prefix will
	// be /docs, which identifies all objects in the docs/ folder. Required when
	// the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals
	// is not specified. If both conditions are specified, both must be true for
	// the redirect to be applied.
	KeyPrefixEquals *string `type:"string"`
	// contains filtered or unexported fields
}

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.

func (Condition) MarshalFields added in v0.3.0

func (s Condition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Condition) String

func (s Condition) String() string

String returns the string representation

type CopyObjectInput

type CopyObjectInput struct {

	// The canned ACL to apply to the object.
	ACL ObjectCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`

	// The name of the destination bucket.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Specifies caching behavior along the request/reply chain.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// Specifies presentational information for the object.
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// Specifies what content encodings have been applied to the object and thus
	// what decoding mechanisms must be applied to obtain the media-type referenced
	// by the Content-Type header field.
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The language the content is in.
	ContentLanguage *string `location:"header" locationName:"Content-Language" type:"string"`

	// A standard MIME type describing the format of the object data.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// The name of the source bucket and key name of the source object, separated
	// by a slash (/). Must be URL-encoded.
	//
	// CopySource is a required field
	CopySource *string `location:"header" locationName:"x-amz-copy-source" type:"string" required:"true"`

	// Copies the object if its entity tag (ETag) matches the specified tag.
	CopySourceIfMatch *string `location:"header" locationName:"x-amz-copy-source-if-match" type:"string"`

	// Copies the object if it has been modified since the specified time.
	CopySourceIfModifiedSince *time.Time `location:"header" locationName:"x-amz-copy-source-if-modified-since" type:"timestamp"`

	// Copies the object if its entity tag (ETag) is different than the specified
	// ETag.
	CopySourceIfNoneMatch *string `location:"header" locationName:"x-amz-copy-source-if-none-match" type:"string"`

	// Copies the object if it hasn't been modified since the specified time.
	CopySourceIfUnmodifiedSince *time.Time `location:"header" locationName:"x-amz-copy-source-if-unmodified-since" type:"timestamp"`

	// Specifies the algorithm to use when decrypting the source object (for example,
	// AES256).
	CopySourceSSECustomerAlgorithm *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use to decrypt
	// the source object. The encryption key provided in this header must be one
	// that was used when the source object was created.
	CopySourceSSECustomerKey *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	CopySourceSSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-key-MD5" type:"string"`

	// The date and time at which the object is no longer cacheable.
	Expires *time.Time `location:"header" locationName:"Expires" type:"timestamp"`

	// Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to read the object data and its metadata.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the object ACL.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to write the ACL for the applicable object.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

	// The key of the destination object.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// A map of metadata to store with the object in S3.
	Metadata map[string]string `location:"headers" locationName:"x-amz-meta-" type:"map"`

	// Specifies whether the metadata is copied from the source object or replaced
	// with metadata provided in the request.
	MetadataDirective MetadataDirective `location:"header" locationName:"x-amz-metadata-directive" type:"string" enum:"true"`

	// Specifies whether you want to apply a Legal Hold to the copied object.
	ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"true"`

	// The Object Lock mode that you want to apply to the copied object.
	ObjectLockMode ObjectLockMode `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"true"`

	// The date and time when you want the copied object's Object Lock to expire.
	ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// Specifies the AWS KMS Encryption Context to use for object encryption. The
	// value of this header is a base64-encoded UTF-8 string holding JSON with the
	// encryption context key-value pairs.
	SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"`

	// Specifies the AWS KMS key ID to use for object encryption. All GET and PUT
	// requests for an object protected by AWS KMS will fail if not made via SSL
	// or using SigV4. For information about configuring using any of the officially
	// supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request
	// Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
	// in the Amazon S3 Developer Guide.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// The type of storage to use for the object. Defaults to 'STANDARD'.
	StorageClass StorageClass `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"true"`

	// The tag-set for the object destination object this value must be used in
	// conjunction with the TaggingDirective. The tag-set must be encoded as URL
	// Query parameters.
	Tagging *string `location:"header" locationName:"x-amz-tagging" type:"string"`

	// Specifies whether the object tag-set are copied from the source object or
	// replaced with tag-set provided in the request.
	TaggingDirective TaggingDirective `location:"header" locationName:"x-amz-tagging-directive" type:"string" enum:"true"`

	// If the bucket is configured as a website, redirects requests for this object
	// to another object in the same bucket or to an external URL. Amazon S3 stores
	// the value of this header in the object metadata.
	WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" type:"string"`
	// contains filtered or unexported fields
}

func (CopyObjectInput) MarshalFields added in v0.3.0

func (s CopyObjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CopyObjectInput) String

func (s CopyObjectInput) String() string

String returns the string representation

func (*CopyObjectInput) Validate

func (s *CopyObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyObjectOutput

type CopyObjectOutput struct {

	// Container for all response elements.
	CopyObjectResult *CopyObjectResult `type:"structure"`

	// Version of the copied object in the destination bucket.
	CopySourceVersionId *string `location:"header" locationName:"x-amz-copy-source-version-id" type:"string"`

	// If the object expiration is configured, the response includes this header.
	Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the AWS KMS Encryption Context to use for object encryption.
	// The value of this header is a base64-encoded UTF-8 string holding JSON with
	// the encryption context key-value pairs.
	SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// Version ID of the newly created copy.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (CopyObjectOutput) MarshalFields added in v0.3.0

func (s CopyObjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CopyObjectOutput) String

func (s CopyObjectOutput) String() string

String returns the string representation

type CopyObjectRequest

type CopyObjectRequest struct {
	*aws.Request
	Input *CopyObjectInput
	Copy  func(*CopyObjectInput) CopyObjectRequest
}

CopyObjectRequest is the request type for the CopyObject API operation.

func (CopyObjectRequest) Send

Send marshals and sends the CopyObject API request.

type CopyObjectResponse added in v0.9.0

type CopyObjectResponse struct {
	*CopyObjectOutput
	// contains filtered or unexported fields
}

CopyObjectResponse is the response type for the CopyObject API operation.

func (*CopyObjectResponse) SDKResponseMetdata added in v0.9.0

func (r *CopyObjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CopyObject request.

type CopyObjectResult

type CopyObjectResult struct {

	// Returns the ETag of the new object. The ETag reflects only changes to the
	// contents of an object, not its metadata. The source and destination ETag
	// is identical for a successfully copied object.
	ETag *string `type:"string"`

	// Returns the date that the object was last modified.
	LastModified *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Container for all response elements.

func (CopyObjectResult) MarshalFields added in v0.3.0

func (s CopyObjectResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CopyObjectResult) String

func (s CopyObjectResult) String() string

String returns the string representation

type CopyPartResult

type CopyPartResult struct {

	// Entity tag of the object.
	ETag *string `type:"string"`

	// Date and time at which the object was uploaded.
	LastModified *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Container for all response elements.

func (CopyPartResult) MarshalFields added in v0.3.0

func (s CopyPartResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CopyPartResult) String

func (s CopyPartResult) String() string

String returns the string representation

type CreateBucketConfiguration

type CreateBucketConfiguration struct {

	// Specifies the Region where the bucket will be created. If you don't specify
	// a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).
	LocationConstraint BucketLocationConstraint `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The configuration information for the bucket.

func (CreateBucketConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateBucketConfiguration) String

func (s CreateBucketConfiguration) String() string

String returns the string representation

type CreateBucketInput

type CreateBucketInput struct {

	// The canned ACL to apply to the bucket.
	ACL BucketCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`

	// The name of the bucket to create.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The configuration information for the bucket.
	CreateBucketConfiguration *CreateBucketConfiguration `locationName:"CreateBucketConfiguration" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// Allows grantee the read, write, read ACP, and write ACP permissions on the
	// bucket.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to list the objects in the bucket.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the bucket ACL.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to create, overwrite, and delete any object in the bucket.
	GrantWrite *string `location:"header" locationName:"x-amz-grant-write" type:"string"`

	// Allows grantee to write the ACL for the applicable bucket.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

	// Specifies whether you want S3 Object Lock to be enabled for the new bucket.
	ObjectLockEnabledForBucket *bool `location:"header" locationName:"x-amz-bucket-object-lock-enabled" type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateBucketInput) MarshalFields added in v0.3.0

func (s CreateBucketInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateBucketInput) String

func (s CreateBucketInput) String() string

String returns the string representation

func (*CreateBucketInput) Validate

func (s *CreateBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBucketOutput

type CreateBucketOutput struct {

	// Specifies the Region where the bucket will be created. If you are creating
	// a bucket on the US East (N. Virginia) Region (us-east-1), you do not need
	// to specify the location.
	Location *string `location:"header" locationName:"Location" type:"string"`
	// contains filtered or unexported fields
}

func (CreateBucketOutput) MarshalFields added in v0.3.0

func (s CreateBucketOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateBucketOutput) String

func (s CreateBucketOutput) String() string

String returns the string representation

type CreateBucketRequest

type CreateBucketRequest struct {
	*aws.Request
	Input *CreateBucketInput
	Copy  func(*CreateBucketInput) CreateBucketRequest
}

CreateBucketRequest is the request type for the CreateBucket API operation.

func (CreateBucketRequest) Send

Send marshals and sends the CreateBucket API request.

type CreateBucketResponse added in v0.9.0

type CreateBucketResponse struct {
	*CreateBucketOutput
	// contains filtered or unexported fields
}

CreateBucketResponse is the response type for the CreateBucket API operation.

func (*CreateBucketResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateBucketResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateBucket request.

type CreateMultipartUploadInput

type CreateMultipartUploadInput struct {

	// The canned ACL to apply to the object.
	ACL ObjectCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`

	// The name of the bucket to which to initiate the upload
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Specifies caching behavior along the request/reply chain.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// Specifies presentational information for the object.
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// Specifies what content encodings have been applied to the object and thus
	// what decoding mechanisms must be applied to obtain the media-type referenced
	// by the Content-Type header field.
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The language the content is in.
	ContentLanguage *string `location:"header" locationName:"Content-Language" type:"string"`

	// A standard MIME type describing the format of the object data.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// The date and time at which the object is no longer cacheable.
	Expires *time.Time `location:"header" locationName:"Expires" type:"timestamp"`

	// Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to read the object data and its metadata.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the object ACL.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to write the ACL for the applicable object.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

	// Object key for which the multipart upload is to be initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// A map of metadata to store with the object in S3.
	Metadata map[string]string `location:"headers" locationName:"x-amz-meta-" type:"map"`

	// Specifies whether you want to apply a Legal Hold to the uploaded object.
	ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"true"`

	// Specifies the Object Lock mode that you want to apply to the uploaded object.
	ObjectLockMode ObjectLockMode `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"true"`

	// Specifies the date and time when you want the Object Lock to expire.
	ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// Specifies the AWS KMS Encryption Context to use for object encryption. The
	// value of this header is a base64-encoded UTF-8 string holding JSON with the
	// encryption context key-value pairs.
	SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"`

	// Specifies the ID of the symmetric customer managed AWS KMS CMK to use for
	// object encryption. All GET and PUT requests for an object protected by AWS
	// KMS will fail if not made via SSL or using SigV4. For information about configuring
	// using any of the officially supported AWS SDKs and AWS CLI, see Specifying
	// the Signature Version in Request Authentication (https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
	// in the Amazon S3 Developer Guide.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// The type of storage to use for the object. Defaults to 'STANDARD'.
	StorageClass StorageClass `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"true"`

	// The tag-set for the object. The tag-set must be encoded as URL Query parameters.
	Tagging *string `location:"header" locationName:"x-amz-tagging" type:"string"`

	// If the bucket is configured as a website, redirects requests for this object
	// to another object in the same bucket or to an external URL. Amazon S3 stores
	// the value of this header in the object metadata.
	WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" type:"string"`
	// contains filtered or unexported fields
}

func (CreateMultipartUploadInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateMultipartUploadInput) String

String returns the string representation

func (*CreateMultipartUploadInput) Validate

func (s *CreateMultipartUploadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMultipartUploadOutput

type CreateMultipartUploadOutput struct {

	// If the bucket has a lifecycle rule configured with an action to abort incomplete
	// multipart uploads and the prefix in the lifecycle rule matches the object
	// name in the request, the response includes this header. The header indicates
	// when the initiated multipart upload becomes eligible for an abort operation.
	// For more information, see Aborting Incomplete Multipart Uploads Using a Bucket
	// Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
	//
	// The response also includes the x-amz-abort-rule-id header that provides the
	// ID of the lifecycle configuration rule that defines this action.
	AbortDate *time.Time `location:"header" locationName:"x-amz-abort-date" type:"timestamp"`

	// This header is returned along with the x-amz-abort-date header. It identifies
	// the applicable lifecycle configuration rule that defines the action to abort
	// incomplete multipart uploads.
	AbortRuleId *string `location:"header" locationName:"x-amz-abort-rule-id" type:"string"`

	// Name of the bucket to which the multipart upload was initiated.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Bucket *string `locationName:"Bucket" type:"string"`

	// Object key for which the multipart upload was initiated.
	Key *string `min:"1" type:"string"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the AWS KMS Encryption Context to use for object encryption.
	// The value of this header is a base64-encoded UTF-8 string holding JSON with
	// the encryption context key-value pairs.
	SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// ID for the initiated multipart upload.
	UploadId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateMultipartUploadOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateMultipartUploadOutput) String

String returns the string representation

type CreateMultipartUploadRequest

type CreateMultipartUploadRequest struct {
	*aws.Request
	Input *CreateMultipartUploadInput
	Copy  func(*CreateMultipartUploadInput) CreateMultipartUploadRequest
}

CreateMultipartUploadRequest is the request type for the CreateMultipartUpload API operation.

func (CreateMultipartUploadRequest) Send

Send marshals and sends the CreateMultipartUpload API request.

type CreateMultipartUploadResponse added in v0.9.0

type CreateMultipartUploadResponse struct {
	*CreateMultipartUploadOutput
	// contains filtered or unexported fields
}

CreateMultipartUploadResponse is the response type for the CreateMultipartUpload API operation.

func (*CreateMultipartUploadResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateMultipartUploadResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateMultipartUpload request.

type DefaultRetention added in v0.6.0

type DefaultRetention struct {

	// The number of days that you want to specify for the default retention period.
	Days *int64 `type:"integer"`

	// The default Object Lock retention mode you want to apply to new objects placed
	// in the specified bucket.
	Mode ObjectLockRetentionMode `type:"string" enum:"true"`

	// The number of years that you want to specify for the default retention period.
	Years *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.

func (DefaultRetention) MarshalFields added in v0.6.0

func (s DefaultRetention) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DefaultRetention) String added in v0.6.0

func (s DefaultRetention) String() string

String returns the string representation

type Delete

type Delete struct {

	// The objects to delete.
	//
	// Objects is a required field
	Objects []ObjectIdentifier `locationName:"Object" type:"list" flattened:"true" required:"true"`

	// Element to enable quiet mode for the request. When you add this element,
	// you must set its value to true.
	Quiet *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Container for the objects to delete.

func (Delete) MarshalFields added in v0.3.0

func (s Delete) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Delete) String

func (s Delete) String() string

String returns the string representation

func (*Delete) Validate

func (s *Delete) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketAnalyticsConfigurationInput

type DeleteBucketAnalyticsConfigurationInput struct {

	// The name of the bucket from which an analytics configuration is deleted.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID that identifies the analytics configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketAnalyticsConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketAnalyticsConfigurationInput) String

String returns the string representation

func (*DeleteBucketAnalyticsConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketAnalyticsConfigurationOutput

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

func (DeleteBucketAnalyticsConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketAnalyticsConfigurationOutput) String

String returns the string representation

type DeleteBucketAnalyticsConfigurationRequest

DeleteBucketAnalyticsConfigurationRequest is the request type for the DeleteBucketAnalyticsConfiguration API operation.

func (DeleteBucketAnalyticsConfigurationRequest) Send

Send marshals and sends the DeleteBucketAnalyticsConfiguration API request.

type DeleteBucketAnalyticsConfigurationResponse added in v0.9.0

type DeleteBucketAnalyticsConfigurationResponse struct {
	*DeleteBucketAnalyticsConfigurationOutput
	// contains filtered or unexported fields
}

DeleteBucketAnalyticsConfigurationResponse is the response type for the DeleteBucketAnalyticsConfiguration API operation.

func (*DeleteBucketAnalyticsConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketAnalyticsConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketAnalyticsConfiguration request.

type DeleteBucketCorsInput

type DeleteBucketCorsInput struct {

	// Specifies the bucket whose cors configuration is being deleted.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketCorsInput) MarshalFields added in v0.3.0

func (s DeleteBucketCorsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketCorsInput) String

func (s DeleteBucketCorsInput) String() string

String returns the string representation

func (*DeleteBucketCorsInput) Validate

func (s *DeleteBucketCorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketCorsOutput

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

func (DeleteBucketCorsOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketCorsOutput) String

func (s DeleteBucketCorsOutput) String() string

String returns the string representation

type DeleteBucketCorsRequest

type DeleteBucketCorsRequest struct {
	*aws.Request
	Input *DeleteBucketCorsInput
	Copy  func(*DeleteBucketCorsInput) DeleteBucketCorsRequest
}

DeleteBucketCorsRequest is the request type for the DeleteBucketCors API operation.

func (DeleteBucketCorsRequest) Send

Send marshals and sends the DeleteBucketCors API request.

type DeleteBucketCorsResponse added in v0.9.0

type DeleteBucketCorsResponse struct {
	*DeleteBucketCorsOutput
	// contains filtered or unexported fields
}

DeleteBucketCorsResponse is the response type for the DeleteBucketCors API operation.

func (*DeleteBucketCorsResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketCorsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketCors request.

type DeleteBucketEncryptionInput added in v0.2.0

type DeleteBucketEncryptionInput struct {

	// The name of the bucket containing the server-side encryption configuration
	// to delete.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketEncryptionInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketEncryptionInput) String added in v0.2.0

String returns the string representation

func (*DeleteBucketEncryptionInput) Validate added in v0.2.0

func (s *DeleteBucketEncryptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketEncryptionOutput added in v0.2.0

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

func (DeleteBucketEncryptionOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketEncryptionOutput) String added in v0.2.0

String returns the string representation

type DeleteBucketEncryptionRequest added in v0.2.0

type DeleteBucketEncryptionRequest struct {
	*aws.Request
	Input *DeleteBucketEncryptionInput
	Copy  func(*DeleteBucketEncryptionInput) DeleteBucketEncryptionRequest
}

DeleteBucketEncryptionRequest is the request type for the DeleteBucketEncryption API operation.

func (DeleteBucketEncryptionRequest) Send added in v0.2.0

Send marshals and sends the DeleteBucketEncryption API request.

type DeleteBucketEncryptionResponse added in v0.9.0

type DeleteBucketEncryptionResponse struct {
	*DeleteBucketEncryptionOutput
	// contains filtered or unexported fields
}

DeleteBucketEncryptionResponse is the response type for the DeleteBucketEncryption API operation.

func (*DeleteBucketEncryptionResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketEncryptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketEncryption request.

type DeleteBucketInput

type DeleteBucketInput struct {

	// Specifies the bucket being deleted.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketInput) MarshalFields added in v0.3.0

func (s DeleteBucketInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketInput) String

func (s DeleteBucketInput) String() string

String returns the string representation

func (*DeleteBucketInput) Validate

func (s *DeleteBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketInventoryConfigurationInput

type DeleteBucketInventoryConfigurationInput struct {

	// The name of the bucket containing the inventory configuration to delete.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID used to identify the inventory configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketInventoryConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketInventoryConfigurationInput) String

String returns the string representation

func (*DeleteBucketInventoryConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketInventoryConfigurationOutput

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

func (DeleteBucketInventoryConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketInventoryConfigurationOutput) String

String returns the string representation

type DeleteBucketInventoryConfigurationRequest

DeleteBucketInventoryConfigurationRequest is the request type for the DeleteBucketInventoryConfiguration API operation.

func (DeleteBucketInventoryConfigurationRequest) Send

Send marshals and sends the DeleteBucketInventoryConfiguration API request.

type DeleteBucketInventoryConfigurationResponse added in v0.9.0

type DeleteBucketInventoryConfigurationResponse struct {
	*DeleteBucketInventoryConfigurationOutput
	// contains filtered or unexported fields
}

DeleteBucketInventoryConfigurationResponse is the response type for the DeleteBucketInventoryConfiguration API operation.

func (*DeleteBucketInventoryConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketInventoryConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketInventoryConfiguration request.

type DeleteBucketLifecycleInput

type DeleteBucketLifecycleInput struct {

	// The bucket name of the lifecycle to delete.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketLifecycleInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketLifecycleInput) String

String returns the string representation

func (*DeleteBucketLifecycleInput) Validate

func (s *DeleteBucketLifecycleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketLifecycleOutput

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

func (DeleteBucketLifecycleOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketLifecycleOutput) String

String returns the string representation

type DeleteBucketLifecycleRequest

type DeleteBucketLifecycleRequest struct {
	*aws.Request
	Input *DeleteBucketLifecycleInput
	Copy  func(*DeleteBucketLifecycleInput) DeleteBucketLifecycleRequest
}

DeleteBucketLifecycleRequest is the request type for the DeleteBucketLifecycle API operation.

func (DeleteBucketLifecycleRequest) Send

Send marshals and sends the DeleteBucketLifecycle API request.

type DeleteBucketLifecycleResponse added in v0.9.0

type DeleteBucketLifecycleResponse struct {
	*DeleteBucketLifecycleOutput
	// contains filtered or unexported fields
}

DeleteBucketLifecycleResponse is the response type for the DeleteBucketLifecycle API operation.

func (*DeleteBucketLifecycleResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketLifecycleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketLifecycle request.

type DeleteBucketMetricsConfigurationInput

type DeleteBucketMetricsConfigurationInput struct {

	// The name of the bucket containing the metrics configuration to delete.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID used to identify the metrics configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketMetricsConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketMetricsConfigurationInput) String

String returns the string representation

func (*DeleteBucketMetricsConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketMetricsConfigurationOutput

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

func (DeleteBucketMetricsConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketMetricsConfigurationOutput) String

String returns the string representation

type DeleteBucketMetricsConfigurationRequest

type DeleteBucketMetricsConfigurationRequest struct {
	*aws.Request
	Input *DeleteBucketMetricsConfigurationInput
	Copy  func(*DeleteBucketMetricsConfigurationInput) DeleteBucketMetricsConfigurationRequest
}

DeleteBucketMetricsConfigurationRequest is the request type for the DeleteBucketMetricsConfiguration API operation.

func (DeleteBucketMetricsConfigurationRequest) Send

Send marshals and sends the DeleteBucketMetricsConfiguration API request.

type DeleteBucketMetricsConfigurationResponse added in v0.9.0

type DeleteBucketMetricsConfigurationResponse struct {
	*DeleteBucketMetricsConfigurationOutput
	// contains filtered or unexported fields
}

DeleteBucketMetricsConfigurationResponse is the response type for the DeleteBucketMetricsConfiguration API operation.

func (*DeleteBucketMetricsConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketMetricsConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketMetricsConfiguration request.

type DeleteBucketOutput

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

func (DeleteBucketOutput) MarshalFields added in v0.3.0

func (s DeleteBucketOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketOutput) String

func (s DeleteBucketOutput) String() string

String returns the string representation

type DeleteBucketPolicyInput

type DeleteBucketPolicyInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketPolicyInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketPolicyInput) String

func (s DeleteBucketPolicyInput) String() string

String returns the string representation

func (*DeleteBucketPolicyInput) Validate

func (s *DeleteBucketPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketPolicyOutput

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

func (DeleteBucketPolicyOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketPolicyOutput) String

func (s DeleteBucketPolicyOutput) String() string

String returns the string representation

type DeleteBucketPolicyRequest

type DeleteBucketPolicyRequest struct {
	*aws.Request
	Input *DeleteBucketPolicyInput
	Copy  func(*DeleteBucketPolicyInput) DeleteBucketPolicyRequest
}

DeleteBucketPolicyRequest is the request type for the DeleteBucketPolicy API operation.

func (DeleteBucketPolicyRequest) Send

Send marshals and sends the DeleteBucketPolicy API request.

type DeleteBucketPolicyResponse added in v0.9.0

type DeleteBucketPolicyResponse struct {
	*DeleteBucketPolicyOutput
	// contains filtered or unexported fields
}

DeleteBucketPolicyResponse is the response type for the DeleteBucketPolicy API operation.

func (*DeleteBucketPolicyResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketPolicy request.

type DeleteBucketReplicationInput

type DeleteBucketReplicationInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketReplicationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketReplicationInput) String

String returns the string representation

func (*DeleteBucketReplicationInput) Validate

func (s *DeleteBucketReplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketReplicationOutput

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

func (DeleteBucketReplicationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketReplicationOutput) String

String returns the string representation

type DeleteBucketReplicationRequest

type DeleteBucketReplicationRequest struct {
	*aws.Request
	Input *DeleteBucketReplicationInput
	Copy  func(*DeleteBucketReplicationInput) DeleteBucketReplicationRequest
}

DeleteBucketReplicationRequest is the request type for the DeleteBucketReplication API operation.

func (DeleteBucketReplicationRequest) Send

Send marshals and sends the DeleteBucketReplication API request.

type DeleteBucketReplicationResponse added in v0.9.0

type DeleteBucketReplicationResponse struct {
	*DeleteBucketReplicationOutput
	// contains filtered or unexported fields
}

DeleteBucketReplicationResponse is the response type for the DeleteBucketReplication API operation.

func (*DeleteBucketReplicationResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketReplicationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketReplication request.

type DeleteBucketRequest

type DeleteBucketRequest struct {
	*aws.Request
	Input *DeleteBucketInput
	Copy  func(*DeleteBucketInput) DeleteBucketRequest
}

DeleteBucketRequest is the request type for the DeleteBucket API operation.

func (DeleteBucketRequest) Send

Send marshals and sends the DeleteBucket API request.

type DeleteBucketResponse added in v0.9.0

type DeleteBucketResponse struct {
	*DeleteBucketOutput
	// contains filtered or unexported fields
}

DeleteBucketResponse is the response type for the DeleteBucket API operation.

func (*DeleteBucketResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucket request.

type DeleteBucketTaggingInput

type DeleteBucketTaggingInput struct {

	// The bucket that has the tag set to be removed.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketTaggingInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketTaggingInput) String

func (s DeleteBucketTaggingInput) String() string

String returns the string representation

func (*DeleteBucketTaggingInput) Validate

func (s *DeleteBucketTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketTaggingOutput

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

func (DeleteBucketTaggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketTaggingOutput) String

func (s DeleteBucketTaggingOutput) String() string

String returns the string representation

type DeleteBucketTaggingRequest

type DeleteBucketTaggingRequest struct {
	*aws.Request
	Input *DeleteBucketTaggingInput
	Copy  func(*DeleteBucketTaggingInput) DeleteBucketTaggingRequest
}

DeleteBucketTaggingRequest is the request type for the DeleteBucketTagging API operation.

func (DeleteBucketTaggingRequest) Send

Send marshals and sends the DeleteBucketTagging API request.

type DeleteBucketTaggingResponse added in v0.9.0

type DeleteBucketTaggingResponse struct {
	*DeleteBucketTaggingOutput
	// contains filtered or unexported fields
}

DeleteBucketTaggingResponse is the response type for the DeleteBucketTagging API operation.

func (*DeleteBucketTaggingResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketTaggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketTagging request.

type DeleteBucketWebsiteInput

type DeleteBucketWebsiteInput struct {

	// The bucket name for which you want to remove the website configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketWebsiteInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketWebsiteInput) String

func (s DeleteBucketWebsiteInput) String() string

String returns the string representation

func (*DeleteBucketWebsiteInput) Validate

func (s *DeleteBucketWebsiteInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketWebsiteOutput

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

func (DeleteBucketWebsiteOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBucketWebsiteOutput) String

func (s DeleteBucketWebsiteOutput) String() string

String returns the string representation

type DeleteBucketWebsiteRequest

type DeleteBucketWebsiteRequest struct {
	*aws.Request
	Input *DeleteBucketWebsiteInput
	Copy  func(*DeleteBucketWebsiteInput) DeleteBucketWebsiteRequest
}

DeleteBucketWebsiteRequest is the request type for the DeleteBucketWebsite API operation.

func (DeleteBucketWebsiteRequest) Send

Send marshals and sends the DeleteBucketWebsite API request.

type DeleteBucketWebsiteResponse added in v0.9.0

type DeleteBucketWebsiteResponse struct {
	*DeleteBucketWebsiteOutput
	// contains filtered or unexported fields
}

DeleteBucketWebsiteResponse is the response type for the DeleteBucketWebsite API operation.

func (*DeleteBucketWebsiteResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBucketWebsiteResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBucketWebsite request.

type DeleteMarkerEntry

type DeleteMarkerEntry struct {

	// Specifies whether the object is (true) or is not (false) the latest version
	// of an object.
	IsLatest *bool `type:"boolean"`

	// The object key.
	Key *string `min:"1" type:"string"`

	// Date and time the object was last modified.
	LastModified *time.Time `type:"timestamp"`

	// The account that created the delete marker.>
	Owner *Owner `type:"structure"`

	// Version ID of an object.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the delete marker.

func (DeleteMarkerEntry) MarshalFields added in v0.3.0

func (s DeleteMarkerEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteMarkerEntry) String

func (s DeleteMarkerEntry) String() string

String returns the string representation

type DeleteMarkerReplication added in v0.5.0

type DeleteMarkerReplication struct {

	// Indicates whether to replicate delete markers.
	//
	// In the current implementation, Amazon S3 doesn't replicate the delete markers.
	// The status must be Disabled.
	Status DeleteMarkerReplicationStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies whether Amazon S3 replicates the delete markers. If you specify a Filter, you must specify this element. However, in the latest version of replication configuration (when Filter is specified), Amazon S3 doesn't replicate delete markers. Therefore, the DeleteMarkerReplication element can contain only <Status>Disabled</Status>. For an example configuration, see Basic Rule Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config).

If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, Amazon S3 handled replication of delete markers differently. For more information, see Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).

func (DeleteMarkerReplication) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteMarkerReplication) String added in v0.5.0

func (s DeleteMarkerReplication) String() string

String returns the string representation

type DeleteMarkerReplicationStatus added in v0.5.0

type DeleteMarkerReplicationStatus string
const (
	DeleteMarkerReplicationStatusEnabled  DeleteMarkerReplicationStatus = "Enabled"
	DeleteMarkerReplicationStatusDisabled DeleteMarkerReplicationStatus = "Disabled"
)

Enum values for DeleteMarkerReplicationStatus

func (DeleteMarkerReplicationStatus) MarshalValue added in v0.5.0

func (enum DeleteMarkerReplicationStatus) MarshalValue() (string, error)

func (DeleteMarkerReplicationStatus) MarshalValueBuf added in v0.5.0

func (enum DeleteMarkerReplicationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DeleteObjectInput

type DeleteObjectInput struct {

	// The bucket name of the bucket containing the object.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Indicates whether S3 Object Lock should bypass Governance-mode restrictions
	// to process this operation.
	BypassGovernanceRetention *bool `location:"header" locationName:"x-amz-bypass-governance-retention" type:"boolean"`

	// Key name of the object to delete.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// The concatenation of the authentication device's serial number, a space,
	// and the value that is displayed on your authentication device. Required to
	// permanently delete a versioned object if versioning is configured with MFA
	// delete enabled.
	MFA *string `location:"header" locationName:"x-amz-mfa" type:"string"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// VersionId used to reference a specific version of the object.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteObjectInput) MarshalFields added in v0.3.0

func (s DeleteObjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteObjectInput) String

func (s DeleteObjectInput) String() string

String returns the string representation

func (*DeleteObjectInput) Validate

func (s *DeleteObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteObjectOutput

type DeleteObjectOutput struct {

	// Specifies whether the versioned object that was permanently deleted was (true)
	// or was not (false) a delete marker.
	DeleteMarker *bool `location:"header" locationName:"x-amz-delete-marker" type:"boolean"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// Returns the version ID of the delete marker created as a result of the DELETE
	// operation.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteObjectOutput) MarshalFields added in v0.3.0

func (s DeleteObjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteObjectOutput) String

func (s DeleteObjectOutput) String() string

String returns the string representation

type DeleteObjectRequest

type DeleteObjectRequest struct {
	*aws.Request
	Input *DeleteObjectInput
	Copy  func(*DeleteObjectInput) DeleteObjectRequest
}

DeleteObjectRequest is the request type for the DeleteObject API operation.

func (DeleteObjectRequest) Send

Send marshals and sends the DeleteObject API request.

type DeleteObjectResponse added in v0.9.0

type DeleteObjectResponse struct {
	*DeleteObjectOutput
	// contains filtered or unexported fields
}

DeleteObjectResponse is the response type for the DeleteObject API operation.

func (*DeleteObjectResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteObjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteObject request.

type DeleteObjectTaggingInput

type DeleteObjectTaggingInput struct {

	// The bucket name containing the objects from which to remove the tags.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Name of the tag.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// The versionId of the object that the tag-set will be removed from.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteObjectTaggingInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteObjectTaggingInput) String

func (s DeleteObjectTaggingInput) String() string

String returns the string representation

func (*DeleteObjectTaggingInput) Validate

func (s *DeleteObjectTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteObjectTaggingOutput

type DeleteObjectTaggingOutput struct {

	// The versionId of the object the tag-set was removed from.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteObjectTaggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteObjectTaggingOutput) String

func (s DeleteObjectTaggingOutput) String() string

String returns the string representation

type DeleteObjectTaggingRequest

type DeleteObjectTaggingRequest struct {
	*aws.Request
	Input *DeleteObjectTaggingInput
	Copy  func(*DeleteObjectTaggingInput) DeleteObjectTaggingRequest
}

DeleteObjectTaggingRequest is the request type for the DeleteObjectTagging API operation.

func (DeleteObjectTaggingRequest) Send

Send marshals and sends the DeleteObjectTagging API request.

type DeleteObjectTaggingResponse added in v0.9.0

type DeleteObjectTaggingResponse struct {
	*DeleteObjectTaggingOutput
	// contains filtered or unexported fields
}

DeleteObjectTaggingResponse is the response type for the DeleteObjectTagging API operation.

func (*DeleteObjectTaggingResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteObjectTaggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteObjectTagging request.

type DeleteObjectsInput

type DeleteObjectsInput struct {

	// The bucket name containing the objects to delete.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Specifies whether you want to delete this object even if it has a Governance-type
	// Object Lock in place. You must have sufficient permissions to perform this
	// operation.
	BypassGovernanceRetention *bool `location:"header" locationName:"x-amz-bypass-governance-retention" type:"boolean"`

	// Container for the request.
	//
	// Delete is a required field
	Delete *Delete `locationName:"Delete" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// The concatenation of the authentication device's serial number, a space,
	// and the value that is displayed on your authentication device. Required to
	// permanently delete a versioned object if versioning is configured with MFA
	// delete enabled.
	MFA *string `location:"header" locationName:"x-amz-mfa" type:"string"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DeleteObjectsInput) MarshalFields added in v0.3.0

func (s DeleteObjectsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteObjectsInput) String

func (s DeleteObjectsInput) String() string

String returns the string representation

func (*DeleteObjectsInput) Validate

func (s *DeleteObjectsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteObjectsOutput

type DeleteObjectsOutput struct {

	// Container element for a successful delete. It identifies the object that
	// was successfully deleted.
	Deleted []DeletedObject `type:"list" flattened:"true"`

	// Container for a failed delete operation that describes the object that Amazon
	// S3 attempted to delete and the error it encountered.
	Errors []Error `locationName:"Error" type:"list" flattened:"true"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DeleteObjectsOutput) MarshalFields added in v0.3.0

func (s DeleteObjectsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteObjectsOutput) String

func (s DeleteObjectsOutput) String() string

String returns the string representation

type DeleteObjectsRequest

type DeleteObjectsRequest struct {
	*aws.Request
	Input *DeleteObjectsInput
	Copy  func(*DeleteObjectsInput) DeleteObjectsRequest
}

DeleteObjectsRequest is the request type for the DeleteObjects API operation.

func (DeleteObjectsRequest) Send

Send marshals and sends the DeleteObjects API request.

type DeleteObjectsResponse added in v0.9.0

type DeleteObjectsResponse struct {
	*DeleteObjectsOutput
	// contains filtered or unexported fields
}

DeleteObjectsResponse is the response type for the DeleteObjects API operation.

func (*DeleteObjectsResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteObjectsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteObjects request.

type DeletePublicAccessBlockInput added in v0.6.0

type DeletePublicAccessBlockInput struct {

	// The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePublicAccessBlockInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePublicAccessBlockInput) String added in v0.6.0

String returns the string representation

func (*DeletePublicAccessBlockInput) Validate added in v0.6.0

func (s *DeletePublicAccessBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePublicAccessBlockOutput added in v0.6.0

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

func (DeletePublicAccessBlockOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePublicAccessBlockOutput) String added in v0.6.0

String returns the string representation

type DeletePublicAccessBlockRequest added in v0.6.0

type DeletePublicAccessBlockRequest struct {
	*aws.Request
	Input *DeletePublicAccessBlockInput
	Copy  func(*DeletePublicAccessBlockInput) DeletePublicAccessBlockRequest
}

DeletePublicAccessBlockRequest is the request type for the DeletePublicAccessBlock API operation.

func (DeletePublicAccessBlockRequest) Send added in v0.6.0

Send marshals and sends the DeletePublicAccessBlock API request.

type DeletePublicAccessBlockResponse added in v0.9.0

type DeletePublicAccessBlockResponse struct {
	*DeletePublicAccessBlockOutput
	// contains filtered or unexported fields
}

DeletePublicAccessBlockResponse is the response type for the DeletePublicAccessBlock API operation.

func (*DeletePublicAccessBlockResponse) SDKResponseMetdata added in v0.9.0

func (r *DeletePublicAccessBlockResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePublicAccessBlock request.

type DeletedObject

type DeletedObject struct {

	// Specifies whether the versioned object that was permanently deleted was (true)
	// or was not (false) a delete marker. In a simple DELETE, this header indicates
	// whether (true) or not (false) a delete marker was created.
	DeleteMarker *bool `type:"boolean"`

	// The version ID of the delete marker created as a result of the DELETE operation.
	// If you delete a specific object version, the value returned by this header
	// is the version ID of the object version deleted.
	DeleteMarkerVersionId *string `type:"string"`

	// The name of the deleted object.
	Key *string `min:"1" type:"string"`

	// The version ID of the deleted object.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the deleted object.

func (DeletedObject) MarshalFields added in v0.3.0

func (s DeletedObject) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletedObject) String

func (s DeletedObject) String() string

String returns the string representation

type Destination

type Destination struct {

	// Specify this only in a cross-account scenario (where source and destination
	// bucket owners are not the same), and you want to change replica ownership
	// to the AWS account that owns the destination bucket. If this is not specified
	// in the replication configuration, the replicas are owned by same AWS account
	// that owns the source object.
	AccessControlTranslation *AccessControlTranslation `type:"structure"`

	// Destination bucket owner account ID. In a cross-account scenario, if you
	// direct Amazon S3 to change replica ownership to the AWS account that owns
	// the destination bucket by specifying the AccessControlTranslation property,
	// this is the account ID of the destination bucket owner. For more information,
	// see Replication Additional Configuration: Changing the Replica Owner (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Account *string `type:"string"`

	// The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to
	// store the results.
	//
	// Bucket is a required field
	Bucket *string `type:"string" required:"true"`

	// A container that provides information about encryption. If SourceSelectionCriteria
	// is specified, you must specify this element.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// A container specifying replication metrics-related settings enabling metrics
	// and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified
	// together with a ReplicationTime block.
	Metrics *Metrics `type:"structure"`

	// A container specifying S3 Replication Time Control (S3 RTC), 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.
	ReplicationTime *ReplicationTime `type:"structure"`

	// The storage class to use when replicating objects, such as S3 Standard or
	// reduced redundancy. By default, Amazon S3 uses the storage class of the source
	// object to create the object replica.
	//
	// For valid values, see the StorageClass element of the PUT Bucket replication
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html)
	// action in the Amazon Simple Storage Service API Reference.
	StorageClass StorageClass `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

func (Destination) MarshalFields added in v0.3.0

func (s Destination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Destination) String

func (s Destination) String() string

String returns the string representation

func (*Destination) Validate

func (s *Destination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncodingType

type EncodingType string

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

const (
	EncodingTypeUrl EncodingType = "url"
)

Enum values for EncodingType

func (EncodingType) MarshalValue added in v0.3.0

func (enum EncodingType) MarshalValue() (string, error)

func (EncodingType) MarshalValueBuf added in v0.3.0

func (enum EncodingType) MarshalValueBuf(b []byte) ([]byte, error)

type Encryption added in v0.2.0

type Encryption struct {

	// The server-side encryption algorithm used when storing job results in Amazon
	// S3 (for example, AES256, aws:kms).
	//
	// EncryptionType is a required field
	EncryptionType ServerSideEncryption `type:"string" required:"true" enum:"true"`

	// If the encryption type is aws:kms, this optional value can be used to specify
	// the encryption context for the restore results.
	KMSContext *string `type:"string"`

	// If the encryption type is aws:kms, this optional value specifies the ID of
	// the symmetric customer managed AWS KMS CMK to use for encryption of job results.
	// Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric
	// and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)
	// in the AWS Key Management Service Developer Guide.
	KMSKeyId *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the type of server-side encryption used.

func (Encryption) MarshalFields added in v0.3.0

func (s Encryption) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Encryption) String added in v0.2.0

func (s Encryption) String() string

String returns the string representation

func (*Encryption) Validate added in v0.2.0

func (s *Encryption) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncryptionConfiguration added in v0.2.0

type EncryptionConfiguration struct {

	// Specifies the ID (Key ARN or Alias ARN) of the customer managed customer
	// master key (CMK) stored in AWS Key Management Service (KMS) for the destination
	// bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only
	// supports symmetric customer managed CMKs. For more information, see Using
	// Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)
	// in the AWS Key Management Service Developer Guide.
	ReplicaKmsKeyID *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

func (EncryptionConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EncryptionConfiguration) String added in v0.2.0

func (s EncryptionConfiguration) String() string

String returns the string representation

type Error

type Error struct {

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// Amazon S3 error codes
	//
	//    * Code: AccessDenied Description: Access Denied HTTP Status Code: 403
	//    Forbidden SOAP Fault Code Prefix: Client
	//
	//    * Code: AccountProblem Description: There is a problem with your AWS account
	//    that prevents the operation from completing successfully. Contact AWS
	//    Support for further assistance. HTTP Status Code: 403 Forbidden SOAP Fault
	//    Code Prefix: Client
	//
	//    * Code: AllAccessDisabled Description: All access to this Amazon S3 resource
	//    has been disabled. Contact AWS Support for further assistance. HTTP Status
	//    Code: 403 Forbidden SOAP Fault Code Prefix: Client
	//
	//    * Code: AmbiguousGrantByEmailAddress Description: The email address you
	//    provided is associated with more than one account. HTTP Status Code: 400
	//    Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: AuthorizationHeaderMalformed Description: The authorization header
	//    you provided is invalid. HTTP Status Code: 400 Bad Request HTTP Status
	//    Code: N/A
	//
	//    * Code: BadDigest Description: The Content-MD5 you specified did not match
	//    what we received. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: BucketAlreadyExists Description: The requested bucket name is
	//    not available. The bucket namespace is shared by all users of the system.
	//    Please select a different name and try again. HTTP Status Code: 409 Conflict
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: BucketAlreadyOwnedByYou Description: The bucket you tried to create
	//    already exists, and you own it. Amazon S3 returns this error in all AWS
	//    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). Code: 409 Conflict (in all Regions except the North
	//    Virginia Region) SOAP Fault Code Prefix: Client
	//
	//    * Code: BucketNotEmpty Description: The bucket you tried to delete is
	//    not empty. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client
	//
	//    * Code: CredentialsNotSupported Description: This request does not support
	//    credentials. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: CrossLocationLoggingProhibited Description: Cross-location logging
	//    not allowed. Buckets in one geographic location cannot log information
	//    to a bucket in another location. HTTP Status Code: 403 Forbidden SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: EntityTooSmall Description: Your proposed upload is smaller than
	//    the minimum allowed object size. HTTP Status Code: 400 Bad Request SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: EntityTooLarge Description: Your proposed upload exceeds the maximum
	//    allowed object size. HTTP Status Code: 400 Bad Request SOAP Fault Code
	//    Prefix: Client
	//
	//    * Code: ExpiredToken Description: The provided token has expired. HTTP
	//    Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: IllegalVersioningConfigurationException Description: Indicates
	//    that the versioning configuration specified in the request is invalid.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: IncompleteBody Description: You did not provide the number of
	//    bytes specified by the Content-Length HTTP header HTTP Status Code: 400
	//    Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: IncorrectNumberOfFilesInPostRequest Description: POST requires
	//    exactly one file upload per request. HTTP Status Code: 400 Bad Request
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: InlineDataTooLarge Description: Inline data exceeds the maximum
	//    allowed size. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: InternalError Description: We encountered an internal error. Please
	//    try again. HTTP Status Code: 500 Internal Server Error SOAP Fault Code
	//    Prefix: Server
	//
	//    * Code: InvalidAccessKeyId Description: The AWS access key ID you provided
	//    does not exist in our records. HTTP Status Code: 403 Forbidden SOAP Fault
	//    Code Prefix: Client
	//
	//    * Code: InvalidAddressingHeader Description: You must specify the Anonymous
	//    role. HTTP Status Code: N/A SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidArgument Description: Invalid Argument HTTP Status Code:
	//    400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidBucketName Description: The specified bucket is not valid.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidBucketState Description: The request is not valid with
	//    the current state of the bucket. HTTP Status Code: 409 Conflict SOAP Fault
	//    Code Prefix: Client
	//
	//    * Code: InvalidDigest Description: The Content-MD5 you specified is not
	//    valid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidEncryptionAlgorithmError Description: The encryption request
	//    you specified is not valid. The valid value is AES256. HTTP Status Code:
	//    400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidLocationConstraint Description: The specified location
	//    constraint is not valid. For more information about Regions, see How to
	//    Select a Region for Your Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidObjectState Description: The operation is not valid for
	//    the current state of the object. HTTP Status Code: 403 Forbidden SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: InvalidPart Description: One or more of the specified parts could
	//    not be found. The part might not have been uploaded, or the specified
	//    entity tag might not have matched the part's entity tag. HTTP Status Code:
	//    400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidPartOrder Description: The list of parts was not in ascending
	//    order. Parts list must be specified in order by part number. HTTP Status
	//    Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidPayer Description: All access to this object has been disabled.
	//    Please contact AWS Support for further assistance. HTTP Status Code: 403
	//    Forbidden SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidPolicyDocument Description: The content of the form does
	//    not meet the conditions specified in the policy document. HTTP Status
	//    Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidRange Description: The requested range cannot be satisfied.
	//    HTTP Status Code: 416 Requested Range Not Satisfiable SOAP Fault Code
	//    Prefix: Client
	//
	//    * Code: InvalidRequest Description: Please use AWS4-HMAC-SHA256. HTTP
	//    Status Code: 400 Bad Request Code: N/A
	//
	//    * Code: InvalidRequest Description: SOAP requests must be made over an
	//    HTTPS connection. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Acceleration is
	//    not supported for buckets with non-DNS compliant names. HTTP Status Code:
	//    400 Bad Request Code: N/A
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Acceleration is
	//    not supported for buckets with periods (.) in their names. HTTP Status
	//    Code: 400 Bad Request Code: N/A
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Accelerate endpoint
	//    only supports virtual style requests. HTTP Status Code: 400 Bad Request
	//    Code: N/A
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Accelerate is not
	//    configured on this bucket. HTTP Status Code: 400 Bad Request Code: N/A
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Accelerate is disabled
	//    on this bucket. HTTP Status Code: 400 Bad Request Code: N/A
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Acceleration is
	//    not supported on this bucket. Contact AWS Support for more information.
	//    HTTP Status Code: 400 Bad Request Code: N/A
	//
	//    * Code: InvalidRequest Description: Amazon S3 Transfer Acceleration cannot
	//    be enabled on this bucket. Contact AWS Support for more information. HTTP
	//    Status Code: 400 Bad Request Code: N/A
	//
	//    * Code: InvalidSecurity Description: The provided security credentials
	//    are not valid. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: InvalidSOAPRequest Description: The SOAP request body is invalid.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidStorageClass Description: The storage class you specified
	//    is not valid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: InvalidTargetBucketForLogging Description: The target bucket for
	//    logging does not exist, is not owned by you, or does not have the appropriate
	//    grants for the log-delivery group. HTTP Status Code: 400 Bad Request SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: InvalidToken Description: The provided token is malformed or otherwise
	//    invalid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: InvalidURI Description: Couldn't parse the specified URI. HTTP
	//    Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: KeyTooLongError Description: Your key is too long. HTTP Status
	//    Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: MalformedACLError Description: The XML you provided was not well-formed
	//    or did not validate against our published schema. HTTP Status Code: 400
	//    Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: MalformedPOSTRequest Description: The body of your POST request
	//    is not well-formed multipart/form-data. HTTP Status Code: 400 Bad Request
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: MalformedXML Description: This happens when the user sends malformed
	//    XML (XML that doesn't conform to the published XSD) for the configuration.
	//    The error message is, "The XML you provided was not well-formed or did
	//    not validate against our published schema." HTTP Status Code: 400 Bad
	//    Request SOAP Fault Code Prefix: Client
	//
	//    * Code: MaxMessageLengthExceeded Description: Your request was too big.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: MaxPostPreDataLengthExceededError Description: Your POST request
	//    fields preceding the upload file were too large. HTTP Status Code: 400
	//    Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: MetadataTooLarge Description: Your metadata headers exceed the
	//    maximum allowed metadata size. HTTP Status Code: 400 Bad Request SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: MethodNotAllowed Description: The specified method is not allowed
	//    against this resource. HTTP Status Code: 405 Method Not Allowed SOAP Fault
	//    Code Prefix: Client
	//
	//    * Code: MissingAttachment Description: A SOAP attachment was expected,
	//    but none were found. HTTP Status Code: N/A SOAP Fault Code Prefix: Client
	//
	//    * Code: MissingContentLength Description: You must provide the Content-Length
	//    HTTP header. HTTP Status Code: 411 Length Required SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: MissingRequestBodyError Description: This happens when the user
	//    sends an empty XML document as a request. The error message is, "Request
	//    body is empty." HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: MissingSecurityElement Description: The SOAP 1.1 request is missing
	//    a security element. HTTP Status Code: 400 Bad Request SOAP Fault Code
	//    Prefix: Client
	//
	//    * Code: MissingSecurityHeader Description: Your request is missing a required
	//    header. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: NoLoggingStatusForKey Description: There is no such thing as a
	//    logging status subresource for a key. HTTP Status Code: 400 Bad Request
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: NoSuchBucket Description: The specified bucket does not exist.
	//    HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client
	//
	//    * Code: NoSuchBucketPolicy Description: The specified bucket does not
	//    have a bucket policy. HTTP Status Code: 404 Not Found SOAP Fault Code
	//    Prefix: Client
	//
	//    * Code: NoSuchKey Description: The specified key does not exist. HTTP
	//    Status Code: 404 Not Found SOAP Fault Code Prefix: Client
	//
	//    * Code: NoSuchLifecycleConfiguration Description: The lifecycle configuration
	//    does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix:
	//    Client
	//
	//    * Code: NoSuchUpload Description: The specified multipart upload does
	//    not exist. The upload ID might be invalid, or the multipart upload might
	//    have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault
	//    Code Prefix: Client
	//
	//    * Code: NoSuchVersion Description: Indicates that the version ID specified
	//    in the request does not match an existing version. HTTP Status Code: 404
	//    Not Found SOAP Fault Code Prefix: Client
	//
	//    * Code: NotImplemented Description: A header you provided implies functionality
	//    that is not implemented. HTTP Status Code: 501 Not Implemented SOAP Fault
	//    Code Prefix: Server
	//
	//    * Code: NotSignedUp Description: Your account is not signed up for the
	//    Amazon S3 service. You must sign up before you can use Amazon S3. You
	//    can sign up at the following URL: https://aws.amazon.com/s3 HTTP Status
	//    Code: 403 Forbidden SOAP Fault Code Prefix: Client
	//
	//    * Code: OperationAborted Description: A conflicting conditional operation
	//    is currently in progress against this resource. Try again. HTTP Status
	//    Code: 409 Conflict SOAP Fault Code Prefix: Client
	//
	//    * Code: PermanentRedirect Description: The bucket you are attempting to
	//    access must be addressed using the specified endpoint. Send all future
	//    requests to this endpoint. HTTP Status Code: 301 Moved Permanently SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: PreconditionFailed Description: At least one of the preconditions
	//    you specified did not hold. HTTP Status Code: 412 Precondition Failed
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: Redirect Description: Temporary redirect. HTTP Status Code: 307
	//    Moved Temporarily SOAP Fault Code Prefix: Client
	//
	//    * Code: RestoreAlreadyInProgress Description: Object restore is already
	//    in progress. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client
	//
	//    * Code: RequestIsNotMultiPartContent Description: Bucket POST must be
	//    of the enclosure-type multipart/form-data. HTTP Status Code: 400 Bad Request
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: RequestTimeout Description: Your socket connection to the server
	//    was not read from or written to within the timeout period. HTTP Status
	//    Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: RequestTimeTooSkewed Description: The difference between the request
	//    time and the server's time is too large. HTTP Status Code: 403 Forbidden
	//    SOAP Fault Code Prefix: Client
	//
	//    * Code: RequestTorrentOfBucketError Description: Requesting the torrent
	//    file of a bucket is not permitted. HTTP Status Code: 400 Bad Request SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: SignatureDoesNotMatch Description: The request signature we calculated
	//    does not match the signature you provided. Check your AWS secret access
	//    key and signing method. For more information, see REST Authentication
	//    (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html)
	//    and SOAP Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html)
	//    for details. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client
	//
	//    * Code: ServiceUnavailable Description: Reduce your request rate. HTTP
	//    Status Code: 503 Service Unavailable SOAP Fault Code Prefix: Server
	//
	//    * Code: SlowDown Description: Reduce your request rate. HTTP Status Code:
	//    503 Slow Down SOAP Fault Code Prefix: Server
	//
	//    * Code: TemporaryRedirect Description: You are being redirected to the
	//    bucket while DNS updates. HTTP Status Code: 307 Moved Temporarily SOAP
	//    Fault Code Prefix: Client
	//
	//    * Code: TokenRefreshRequired Description: The provided token must be refreshed.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: TooManyBuckets Description: You have attempted to create more
	//    buckets than allowed. HTTP Status Code: 400 Bad Request SOAP Fault Code
	//    Prefix: Client
	//
	//    * Code: UnexpectedContent Description: This request does not support content.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: UnresolvableGrantByEmailAddress Description: The email address
	//    you provided does not match any account on record. HTTP Status Code: 400
	//    Bad Request SOAP Fault Code Prefix: Client
	//
	//    * Code: UserKeyMustBeSpecified Description: The bucket POST must contain
	//    the specified field name. If it is specified, check the order of the fields.
	//    HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
	Code *string `type:"string"`

	// The error key.
	Key *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message *string `type:"string"`

	// The version ID of the error.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Container for all error elements.

func (Error) MarshalFields added in v0.3.0

func (s Error) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Error) String

func (s Error) String() string

String returns the string representation

type ErrorDocument

type ErrorDocument struct {

	// The object key name to use when a 4XX class error occurs.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The error information.

func (ErrorDocument) MarshalFields added in v0.3.0

func (s ErrorDocument) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorDocument) String

func (s ErrorDocument) String() string

String returns the string representation

func (*ErrorDocument) Validate

func (s *ErrorDocument) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Event

type Event string

The bucket event for which to send notifications.

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"
)

Enum values for Event

func (Event) MarshalValue added in v0.3.0

func (enum Event) MarshalValue() (string, error)

func (Event) MarshalValueBuf added in v0.3.0

func (enum Event) MarshalValueBuf(b []byte) ([]byte, error)

type ExistingObjectReplication added in v0.17.0

type ExistingObjectReplication struct {

	// Status is a required field
	Status ExistingObjectReplicationStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication) in the Amazon S3 Developer Guide.

func (ExistingObjectReplication) MarshalFields added in v0.17.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExistingObjectReplication) String added in v0.17.0

func (s ExistingObjectReplication) String() string

String returns the string representation

func (*ExistingObjectReplication) Validate added in v0.17.0

func (s *ExistingObjectReplication) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExistingObjectReplicationStatus added in v0.17.0

type ExistingObjectReplicationStatus string
const (
	ExistingObjectReplicationStatusEnabled  ExistingObjectReplicationStatus = "Enabled"
	ExistingObjectReplicationStatusDisabled ExistingObjectReplicationStatus = "Disabled"
)

Enum values for ExistingObjectReplicationStatus

func (ExistingObjectReplicationStatus) MarshalValue added in v0.17.0

func (enum ExistingObjectReplicationStatus) MarshalValue() (string, error)

func (ExistingObjectReplicationStatus) MarshalValueBuf added in v0.17.0

func (enum ExistingObjectReplicationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ExpirationStatus

type ExpirationStatus string
const (
	ExpirationStatusEnabled  ExpirationStatus = "Enabled"
	ExpirationStatusDisabled ExpirationStatus = "Disabled"
)

Enum values for ExpirationStatus

func (ExpirationStatus) MarshalValue added in v0.3.0

func (enum ExpirationStatus) MarshalValue() (string, error)

func (ExpirationStatus) MarshalValueBuf added in v0.3.0

func (enum ExpirationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ExpressionType added in v0.2.0

type ExpressionType string
const (
	ExpressionTypeSql ExpressionType = "SQL"
)

Enum values for ExpressionType

func (ExpressionType) MarshalValue added in v0.3.0

func (enum ExpressionType) MarshalValue() (string, error)

func (ExpressionType) MarshalValueBuf added in v0.3.0

func (enum ExpressionType) MarshalValueBuf(b []byte) ([]byte, error)

type FileHeaderInfo added in v0.2.0

type FileHeaderInfo string
const (
	FileHeaderInfoUse    FileHeaderInfo = "USE"
	FileHeaderInfoIgnore FileHeaderInfo = "IGNORE"
	FileHeaderInfoNone   FileHeaderInfo = "NONE"
)

Enum values for FileHeaderInfo

func (FileHeaderInfo) MarshalValue added in v0.3.0

func (enum FileHeaderInfo) MarshalValue() (string, error)

func (FileHeaderInfo) MarshalValueBuf added in v0.3.0

func (enum FileHeaderInfo) MarshalValueBuf(b []byte) ([]byte, error)

type FilterRule

type FilterRule struct {

	// The object key name prefix or suffix identifying one or more objects to which
	// the filtering rule applies. The maximum length is 1,024 characters. Overlapping
	// prefixes and suffixes are not supported. For more information, see Configuring
	// Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Name FilterRuleName `type:"string" enum:"true"`

	// The value that the filter searches for in object key names.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

func (FilterRule) MarshalFields added in v0.3.0

func (s FilterRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FilterRule) String

func (s FilterRule) String() string

String returns the string representation

type FilterRuleName

type FilterRuleName string
const (
	FilterRuleNamePrefix FilterRuleName = "prefix"
	FilterRuleNameSuffix FilterRuleName = "suffix"
)

Enum values for FilterRuleName

func (FilterRuleName) MarshalValue added in v0.3.0

func (enum FilterRuleName) MarshalValue() (string, error)

func (FilterRuleName) MarshalValueBuf added in v0.3.0

func (enum FilterRuleName) MarshalValueBuf(b []byte) ([]byte, error)

type GetBucketAccelerateConfigurationInput

type GetBucketAccelerateConfigurationInput struct {

	// Name of the bucket for which the accelerate configuration is retrieved.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketAccelerateConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketAccelerateConfigurationInput) String

String returns the string representation

func (*GetBucketAccelerateConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBucketAccelerateConfigurationOutput

type GetBucketAccelerateConfigurationOutput struct {

	// The accelerate configuration of the bucket.
	Status BucketAccelerateStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetBucketAccelerateConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketAccelerateConfigurationOutput) String

String returns the string representation

type GetBucketAccelerateConfigurationRequest

type GetBucketAccelerateConfigurationRequest struct {
	*aws.Request
	Input *GetBucketAccelerateConfigurationInput
	Copy  func(*GetBucketAccelerateConfigurationInput) GetBucketAccelerateConfigurationRequest
}

GetBucketAccelerateConfigurationRequest is the request type for the GetBucketAccelerateConfiguration API operation.

func (GetBucketAccelerateConfigurationRequest) Send

Send marshals and sends the GetBucketAccelerateConfiguration API request.

type GetBucketAccelerateConfigurationResponse added in v0.9.0

type GetBucketAccelerateConfigurationResponse struct {
	*GetBucketAccelerateConfigurationOutput
	// contains filtered or unexported fields
}

GetBucketAccelerateConfigurationResponse is the response type for the GetBucketAccelerateConfiguration API operation.

func (*GetBucketAccelerateConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketAccelerateConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketAccelerateConfiguration request.

type GetBucketAclInput

type GetBucketAclInput struct {

	// Specifies the S3 bucket whose ACL is being requested.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketAclInput) MarshalFields added in v0.3.0

func (s GetBucketAclInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketAclInput) String

func (s GetBucketAclInput) String() string

String returns the string representation

func (*GetBucketAclInput) Validate

func (s *GetBucketAclInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketAclOutput

type GetBucketAclOutput struct {

	// A list of grants.
	Grants []Grant `locationName:"AccessControlList" locationNameList:"Grant" type:"list"`

	// Container for the bucket owner's display name and ID.
	Owner *Owner `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketAclOutput) MarshalFields added in v0.3.0

func (s GetBucketAclOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketAclOutput) String

func (s GetBucketAclOutput) String() string

String returns the string representation

type GetBucketAclRequest

type GetBucketAclRequest struct {
	*aws.Request
	Input *GetBucketAclInput
	Copy  func(*GetBucketAclInput) GetBucketAclRequest
}

GetBucketAclRequest is the request type for the GetBucketAcl API operation.

func (GetBucketAclRequest) Send

Send marshals and sends the GetBucketAcl API request.

type GetBucketAclResponse added in v0.9.0

type GetBucketAclResponse struct {
	*GetBucketAclOutput
	// contains filtered or unexported fields
}

GetBucketAclResponse is the response type for the GetBucketAcl API operation.

func (*GetBucketAclResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketAclResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketAcl request.

type GetBucketAnalyticsConfigurationInput

type GetBucketAnalyticsConfigurationInput struct {

	// The name of the bucket from which an analytics configuration is retrieved.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID that identifies the analytics configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketAnalyticsConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketAnalyticsConfigurationInput) String

String returns the string representation

func (*GetBucketAnalyticsConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBucketAnalyticsConfigurationOutput

type GetBucketAnalyticsConfigurationOutput struct {

	// The configuration and any analyses for the analytics filter.
	AnalyticsConfiguration *AnalyticsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketAnalyticsConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketAnalyticsConfigurationOutput) String

String returns the string representation

type GetBucketAnalyticsConfigurationRequest

type GetBucketAnalyticsConfigurationRequest struct {
	*aws.Request
	Input *GetBucketAnalyticsConfigurationInput
	Copy  func(*GetBucketAnalyticsConfigurationInput) GetBucketAnalyticsConfigurationRequest
}

GetBucketAnalyticsConfigurationRequest is the request type for the GetBucketAnalyticsConfiguration API operation.

func (GetBucketAnalyticsConfigurationRequest) Send

Send marshals and sends the GetBucketAnalyticsConfiguration API request.

type GetBucketAnalyticsConfigurationResponse added in v0.9.0

type GetBucketAnalyticsConfigurationResponse struct {
	*GetBucketAnalyticsConfigurationOutput
	// contains filtered or unexported fields
}

GetBucketAnalyticsConfigurationResponse is the response type for the GetBucketAnalyticsConfiguration API operation.

func (*GetBucketAnalyticsConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketAnalyticsConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketAnalyticsConfiguration request.

type GetBucketCorsInput

type GetBucketCorsInput struct {

	// The bucket name for which to get the cors configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketCorsInput) MarshalFields added in v0.3.0

func (s GetBucketCorsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketCorsInput) String

func (s GetBucketCorsInput) String() string

String returns the string representation

func (*GetBucketCorsInput) Validate

func (s *GetBucketCorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketCorsOutput

type GetBucketCorsOutput struct {

	// A set of origins and methods (cross-origin access that you want to allow).
	// You can add up to 100 rules to the configuration.
	CORSRules []CORSRule `locationName:"CORSRule" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (GetBucketCorsOutput) MarshalFields added in v0.3.0

func (s GetBucketCorsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketCorsOutput) String

func (s GetBucketCorsOutput) String() string

String returns the string representation

type GetBucketCorsRequest

type GetBucketCorsRequest struct {
	*aws.Request
	Input *GetBucketCorsInput
	Copy  func(*GetBucketCorsInput) GetBucketCorsRequest
}

GetBucketCorsRequest is the request type for the GetBucketCors API operation.

func (GetBucketCorsRequest) Send

Send marshals and sends the GetBucketCors API request.

type GetBucketCorsResponse added in v0.9.0

type GetBucketCorsResponse struct {
	*GetBucketCorsOutput
	// contains filtered or unexported fields
}

GetBucketCorsResponse is the response type for the GetBucketCors API operation.

func (*GetBucketCorsResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketCorsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketCors request.

type GetBucketEncryptionInput added in v0.2.0

type GetBucketEncryptionInput struct {

	// The name of the bucket from which the server-side encryption configuration
	// is retrieved.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketEncryptionInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketEncryptionInput) String added in v0.2.0

func (s GetBucketEncryptionInput) String() string

String returns the string representation

func (*GetBucketEncryptionInput) Validate added in v0.2.0

func (s *GetBucketEncryptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketEncryptionOutput added in v0.2.0

type GetBucketEncryptionOutput struct {

	// Specifies the default server-side-encryption configuration.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketEncryptionOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketEncryptionOutput) String added in v0.2.0

func (s GetBucketEncryptionOutput) String() string

String returns the string representation

type GetBucketEncryptionRequest added in v0.2.0

type GetBucketEncryptionRequest struct {
	*aws.Request
	Input *GetBucketEncryptionInput
	Copy  func(*GetBucketEncryptionInput) GetBucketEncryptionRequest
}

GetBucketEncryptionRequest is the request type for the GetBucketEncryption API operation.

func (GetBucketEncryptionRequest) Send added in v0.2.0

Send marshals and sends the GetBucketEncryption API request.

type GetBucketEncryptionResponse added in v0.9.0

type GetBucketEncryptionResponse struct {
	*GetBucketEncryptionOutput
	// contains filtered or unexported fields
}

GetBucketEncryptionResponse is the response type for the GetBucketEncryption API operation.

func (*GetBucketEncryptionResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketEncryptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketEncryption request.

type GetBucketInventoryConfigurationInput

type GetBucketInventoryConfigurationInput struct {

	// The name of the bucket containing the inventory configuration to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID used to identify the inventory configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketInventoryConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketInventoryConfigurationInput) String

String returns the string representation

func (*GetBucketInventoryConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBucketInventoryConfigurationOutput

type GetBucketInventoryConfigurationOutput struct {

	// Specifies the inventory configuration.
	InventoryConfiguration *InventoryConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketInventoryConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketInventoryConfigurationOutput) String

String returns the string representation

type GetBucketInventoryConfigurationRequest

type GetBucketInventoryConfigurationRequest struct {
	*aws.Request
	Input *GetBucketInventoryConfigurationInput
	Copy  func(*GetBucketInventoryConfigurationInput) GetBucketInventoryConfigurationRequest
}

GetBucketInventoryConfigurationRequest is the request type for the GetBucketInventoryConfiguration API operation.

func (GetBucketInventoryConfigurationRequest) Send

Send marshals and sends the GetBucketInventoryConfiguration API request.

type GetBucketInventoryConfigurationResponse added in v0.9.0

type GetBucketInventoryConfigurationResponse struct {
	*GetBucketInventoryConfigurationOutput
	// contains filtered or unexported fields
}

GetBucketInventoryConfigurationResponse is the response type for the GetBucketInventoryConfiguration API operation.

func (*GetBucketInventoryConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketInventoryConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketInventoryConfiguration request.

type GetBucketLifecycleConfigurationInput

type GetBucketLifecycleConfigurationInput struct {

	// The name of the bucket for which to get the lifecycle information.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLifecycleConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLifecycleConfigurationInput) String

String returns the string representation

func (*GetBucketLifecycleConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBucketLifecycleConfigurationOutput

type GetBucketLifecycleConfigurationOutput struct {

	// Container for a lifecycle rule.
	Rules []LifecycleRule `locationName:"Rule" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLifecycleConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLifecycleConfigurationOutput) String

String returns the string representation

type GetBucketLifecycleConfigurationRequest

type GetBucketLifecycleConfigurationRequest struct {
	*aws.Request
	Input *GetBucketLifecycleConfigurationInput
	Copy  func(*GetBucketLifecycleConfigurationInput) GetBucketLifecycleConfigurationRequest
}

GetBucketLifecycleConfigurationRequest is the request type for the GetBucketLifecycleConfiguration API operation.

func (GetBucketLifecycleConfigurationRequest) Send

Send marshals and sends the GetBucketLifecycleConfiguration API request.

type GetBucketLifecycleConfigurationResponse added in v0.9.0

type GetBucketLifecycleConfigurationResponse struct {
	*GetBucketLifecycleConfigurationOutput
	// contains filtered or unexported fields
}

GetBucketLifecycleConfigurationResponse is the response type for the GetBucketLifecycleConfiguration API operation.

func (*GetBucketLifecycleConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketLifecycleConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketLifecycleConfiguration request.

type GetBucketLifecycleInput

type GetBucketLifecycleInput struct {

	// The name of the bucket for which to get the lifecycle information.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLifecycleInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLifecycleInput) String

func (s GetBucketLifecycleInput) String() string

String returns the string representation

func (*GetBucketLifecycleInput) Validate

func (s *GetBucketLifecycleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketLifecycleOutput

type GetBucketLifecycleOutput struct {

	// Container for a lifecycle rule.
	Rules []Rule `locationName:"Rule" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLifecycleOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLifecycleOutput) String

func (s GetBucketLifecycleOutput) String() string

String returns the string representation

type GetBucketLifecycleRequest

type GetBucketLifecycleRequest struct {
	*aws.Request
	Input *GetBucketLifecycleInput
	Copy  func(*GetBucketLifecycleInput) GetBucketLifecycleRequest
}

GetBucketLifecycleRequest is the request type for the GetBucketLifecycle API operation.

func (GetBucketLifecycleRequest) Send

Send marshals and sends the GetBucketLifecycle API request.

type GetBucketLifecycleResponse added in v0.9.0

type GetBucketLifecycleResponse struct {
	*GetBucketLifecycleOutput
	// contains filtered or unexported fields
}

GetBucketLifecycleResponse is the response type for the GetBucketLifecycle API operation.

func (*GetBucketLifecycleResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketLifecycleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketLifecycle request.

type GetBucketLocationInput

type GetBucketLocationInput struct {

	// The name of the bucket for which to get the location.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLocationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLocationInput) String

func (s GetBucketLocationInput) String() string

String returns the string representation

func (*GetBucketLocationInput) Validate

func (s *GetBucketLocationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketLocationOutput

type GetBucketLocationOutput struct {

	// Specifies the Region where the bucket resides. For a list of all the Amazon
	// S3 supported location constraints by Region, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region).
	// Buckets in Region us-east-1 have a LocationConstraint of null.
	LocationConstraint BucketLocationConstraint `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLocationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLocationOutput) String

func (s GetBucketLocationOutput) String() string

String returns the string representation

type GetBucketLocationRequest

type GetBucketLocationRequest struct {
	*aws.Request
	Input *GetBucketLocationInput
	Copy  func(*GetBucketLocationInput) GetBucketLocationRequest
}

GetBucketLocationRequest is the request type for the GetBucketLocation API operation.

func (GetBucketLocationRequest) Send

Send marshals and sends the GetBucketLocation API request.

type GetBucketLocationResponse added in v0.9.0

type GetBucketLocationResponse struct {
	*GetBucketLocationOutput
	// contains filtered or unexported fields
}

GetBucketLocationResponse is the response type for the GetBucketLocation API operation.

func (*GetBucketLocationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketLocationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketLocation request.

type GetBucketLoggingInput

type GetBucketLoggingInput struct {

	// The bucket name for which to get the logging information.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLoggingInput) MarshalFields added in v0.3.0

func (s GetBucketLoggingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLoggingInput) String

func (s GetBucketLoggingInput) String() string

String returns the string representation

func (*GetBucketLoggingInput) Validate

func (s *GetBucketLoggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketLoggingOutput

type GetBucketLoggingOutput struct {

	// 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 logging
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html)
	// in the Amazon Simple Storage Service API Reference.
	LoggingEnabled *LoggingEnabled `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketLoggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketLoggingOutput) String

func (s GetBucketLoggingOutput) String() string

String returns the string representation

type GetBucketLoggingRequest

type GetBucketLoggingRequest struct {
	*aws.Request
	Input *GetBucketLoggingInput
	Copy  func(*GetBucketLoggingInput) GetBucketLoggingRequest
}

GetBucketLoggingRequest is the request type for the GetBucketLogging API operation.

func (GetBucketLoggingRequest) Send

Send marshals and sends the GetBucketLogging API request.

type GetBucketLoggingResponse added in v0.9.0

type GetBucketLoggingResponse struct {
	*GetBucketLoggingOutput
	// contains filtered or unexported fields
}

GetBucketLoggingResponse is the response type for the GetBucketLogging API operation.

func (*GetBucketLoggingResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketLoggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketLogging request.

type GetBucketMetricsConfigurationInput

type GetBucketMetricsConfigurationInput struct {

	// The name of the bucket containing the metrics configuration to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID used to identify the metrics configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketMetricsConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketMetricsConfigurationInput) String

String returns the string representation

func (*GetBucketMetricsConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBucketMetricsConfigurationOutput

type GetBucketMetricsConfigurationOutput struct {

	// Specifies the metrics configuration.
	MetricsConfiguration *MetricsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketMetricsConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketMetricsConfigurationOutput) String

String returns the string representation

type GetBucketMetricsConfigurationRequest

type GetBucketMetricsConfigurationRequest struct {
	*aws.Request
	Input *GetBucketMetricsConfigurationInput
	Copy  func(*GetBucketMetricsConfigurationInput) GetBucketMetricsConfigurationRequest
}

GetBucketMetricsConfigurationRequest is the request type for the GetBucketMetricsConfiguration API operation.

func (GetBucketMetricsConfigurationRequest) Send

Send marshals and sends the GetBucketMetricsConfiguration API request.

type GetBucketMetricsConfigurationResponse added in v0.9.0

type GetBucketMetricsConfigurationResponse struct {
	*GetBucketMetricsConfigurationOutput
	// contains filtered or unexported fields
}

GetBucketMetricsConfigurationResponse is the response type for the GetBucketMetricsConfiguration API operation.

func (*GetBucketMetricsConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketMetricsConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketMetricsConfiguration request.

type GetBucketNotificationConfigurationInput

type GetBucketNotificationConfigurationInput struct {

	// Name of the bucket for which to get the notification configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketNotificationConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketNotificationConfigurationInput) String

String returns the string representation

func (*GetBucketNotificationConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBucketNotificationConfigurationOutput

type GetBucketNotificationConfigurationOutput struct {

	// Describes the AWS Lambda functions to invoke and the events for which to
	// invoke them.
	LambdaFunctionConfigurations []LambdaFunctionConfiguration `locationName:"CloudFunctionConfiguration" type:"list" flattened:"true"`

	// The Amazon Simple Queue Service queues to publish messages to and the events
	// for which to publish messages.
	QueueConfigurations []QueueConfiguration `locationName:"QueueConfiguration" type:"list" flattened:"true"`

	// The topic to which notifications are sent and the events for which notifications
	// are generated.
	TopicConfigurations []TopicConfiguration `locationName:"TopicConfiguration" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

func (GetBucketNotificationConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketNotificationConfigurationOutput) String

String returns the string representation

type GetBucketNotificationConfigurationRequest

GetBucketNotificationConfigurationRequest is the request type for the GetBucketNotificationConfiguration API operation.

func (GetBucketNotificationConfigurationRequest) Send

Send marshals and sends the GetBucketNotificationConfiguration API request.

type GetBucketNotificationConfigurationResponse added in v0.9.0

type GetBucketNotificationConfigurationResponse struct {
	*GetBucketNotificationConfigurationOutput
	// contains filtered or unexported fields
}

GetBucketNotificationConfigurationResponse is the response type for the GetBucketNotificationConfiguration API operation.

func (*GetBucketNotificationConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketNotificationConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketNotificationConfiguration request.

type GetBucketNotificationInput added in v0.9.0

type GetBucketNotificationInput struct {

	// Name of the bucket for which to get the notification configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketNotificationInput) MarshalFields added in v0.9.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketNotificationInput) String added in v0.9.0

String returns the string representation

func (*GetBucketNotificationInput) Validate added in v0.9.0

func (s *GetBucketNotificationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketNotificationOutput

type GetBucketNotificationOutput struct {

	// Container for specifying the AWS Lambda notification configuration.
	CloudFunctionConfiguration *CloudFunctionConfiguration `type:"structure"`

	// This data type is deprecated. This data type specifies the configuration
	// for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue
	// when Amazon S3 detects specified events.
	QueueConfiguration *QueueConfigurationDeprecated `type:"structure"`

	// This data type is deprecated. 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.
	TopicConfiguration *TopicConfigurationDeprecated `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketNotificationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketNotificationOutput) String

String returns the string representation

type GetBucketNotificationRequest

type GetBucketNotificationRequest struct {
	*aws.Request
	Input *GetBucketNotificationInput
	Copy  func(*GetBucketNotificationInput) GetBucketNotificationRequest
}

GetBucketNotificationRequest is the request type for the GetBucketNotification API operation.

func (GetBucketNotificationRequest) Send

Send marshals and sends the GetBucketNotification API request.

type GetBucketNotificationResponse added in v0.9.0

type GetBucketNotificationResponse struct {
	*GetBucketNotificationOutput
	// contains filtered or unexported fields
}

GetBucketNotificationResponse is the response type for the GetBucketNotification API operation.

func (*GetBucketNotificationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketNotificationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketNotification request.

type GetBucketPolicyInput

type GetBucketPolicyInput struct {

	// The bucket name for which to get the bucket policy.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketPolicyInput) MarshalFields added in v0.3.0

func (s GetBucketPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketPolicyInput) String

func (s GetBucketPolicyInput) String() string

String returns the string representation

func (*GetBucketPolicyInput) Validate

func (s *GetBucketPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketPolicyOutput

type GetBucketPolicyOutput struct {

	// The bucket policy as a JSON document.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetBucketPolicyOutput) MarshalFields added in v0.3.0

func (s GetBucketPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketPolicyOutput) String

func (s GetBucketPolicyOutput) String() string

String returns the string representation

type GetBucketPolicyRequest

type GetBucketPolicyRequest struct {
	*aws.Request
	Input *GetBucketPolicyInput
	Copy  func(*GetBucketPolicyInput) GetBucketPolicyRequest
}

GetBucketPolicyRequest is the request type for the GetBucketPolicy API operation.

func (GetBucketPolicyRequest) Send

Send marshals and sends the GetBucketPolicy API request.

type GetBucketPolicyResponse added in v0.9.0

type GetBucketPolicyResponse struct {
	*GetBucketPolicyOutput
	// contains filtered or unexported fields
}

GetBucketPolicyResponse is the response type for the GetBucketPolicy API operation.

func (*GetBucketPolicyResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketPolicy request.

type GetBucketPolicyStatusInput added in v0.6.0

type GetBucketPolicyStatusInput struct {

	// The name of the Amazon S3 bucket whose policy status you want to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketPolicyStatusInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketPolicyStatusInput) String added in v0.6.0

String returns the string representation

func (*GetBucketPolicyStatusInput) Validate added in v0.6.0

func (s *GetBucketPolicyStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketPolicyStatusOutput added in v0.6.0

type GetBucketPolicyStatusOutput struct {

	// The policy status for the specified bucket.
	PolicyStatus *PolicyStatus `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketPolicyStatusOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketPolicyStatusOutput) String added in v0.6.0

String returns the string representation

type GetBucketPolicyStatusRequest added in v0.6.0

type GetBucketPolicyStatusRequest struct {
	*aws.Request
	Input *GetBucketPolicyStatusInput
	Copy  func(*GetBucketPolicyStatusInput) GetBucketPolicyStatusRequest
}

GetBucketPolicyStatusRequest is the request type for the GetBucketPolicyStatus API operation.

func (GetBucketPolicyStatusRequest) Send added in v0.6.0

Send marshals and sends the GetBucketPolicyStatus API request.

type GetBucketPolicyStatusResponse added in v0.9.0

type GetBucketPolicyStatusResponse struct {
	*GetBucketPolicyStatusOutput
	// contains filtered or unexported fields
}

GetBucketPolicyStatusResponse is the response type for the GetBucketPolicyStatus API operation.

func (*GetBucketPolicyStatusResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketPolicyStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketPolicyStatus request.

type GetBucketReplicationInput

type GetBucketReplicationInput struct {

	// The bucket name for which to get the replication information.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketReplicationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketReplicationInput) String

func (s GetBucketReplicationInput) String() string

String returns the string representation

func (*GetBucketReplicationInput) Validate

func (s *GetBucketReplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketReplicationOutput

type GetBucketReplicationOutput struct {

	// A container for replication rules. You can add up to 1,000 rules. The maximum
	// size of a replication configuration is 2 MB.
	ReplicationConfiguration *ReplicationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBucketReplicationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketReplicationOutput) String

String returns the string representation

type GetBucketReplicationRequest

type GetBucketReplicationRequest struct {
	*aws.Request
	Input *GetBucketReplicationInput
	Copy  func(*GetBucketReplicationInput) GetBucketReplicationRequest
}

GetBucketReplicationRequest is the request type for the GetBucketReplication API operation.

func (GetBucketReplicationRequest) Send

Send marshals and sends the GetBucketReplication API request.

type GetBucketReplicationResponse added in v0.9.0

type GetBucketReplicationResponse struct {
	*GetBucketReplicationOutput
	// contains filtered or unexported fields
}

GetBucketReplicationResponse is the response type for the GetBucketReplication API operation.

func (*GetBucketReplicationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketReplicationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketReplication request.

type GetBucketRequestPaymentInput

type GetBucketRequestPaymentInput struct {

	// The name of the bucket for which to get the payment request configuration
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketRequestPaymentInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketRequestPaymentInput) String

String returns the string representation

func (*GetBucketRequestPaymentInput) Validate

func (s *GetBucketRequestPaymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketRequestPaymentOutput

type GetBucketRequestPaymentOutput struct {

	// Specifies who pays for the download and request fees.
	Payer Payer `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetBucketRequestPaymentOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketRequestPaymentOutput) String

String returns the string representation

type GetBucketRequestPaymentRequest

type GetBucketRequestPaymentRequest struct {
	*aws.Request
	Input *GetBucketRequestPaymentInput
	Copy  func(*GetBucketRequestPaymentInput) GetBucketRequestPaymentRequest
}

GetBucketRequestPaymentRequest is the request type for the GetBucketRequestPayment API operation.

func (GetBucketRequestPaymentRequest) Send

Send marshals and sends the GetBucketRequestPayment API request.

type GetBucketRequestPaymentResponse added in v0.9.0

type GetBucketRequestPaymentResponse struct {
	*GetBucketRequestPaymentOutput
	// contains filtered or unexported fields
}

GetBucketRequestPaymentResponse is the response type for the GetBucketRequestPayment API operation.

func (*GetBucketRequestPaymentResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketRequestPaymentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketRequestPayment request.

type GetBucketTaggingInput

type GetBucketTaggingInput struct {

	// The name of the bucket for which to get the tagging information.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketTaggingInput) MarshalFields added in v0.3.0

func (s GetBucketTaggingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketTaggingInput) String

func (s GetBucketTaggingInput) String() string

String returns the string representation

func (*GetBucketTaggingInput) Validate

func (s *GetBucketTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketTaggingOutput

type GetBucketTaggingOutput struct {

	// Contains the tag set.
	//
	// TagSet is a required field
	TagSet []Tag `locationNameList:"Tag" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketTaggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketTaggingOutput) String

func (s GetBucketTaggingOutput) String() string

String returns the string representation

type GetBucketTaggingRequest

type GetBucketTaggingRequest struct {
	*aws.Request
	Input *GetBucketTaggingInput
	Copy  func(*GetBucketTaggingInput) GetBucketTaggingRequest
}

GetBucketTaggingRequest is the request type for the GetBucketTagging API operation.

func (GetBucketTaggingRequest) Send

Send marshals and sends the GetBucketTagging API request.

type GetBucketTaggingResponse added in v0.9.0

type GetBucketTaggingResponse struct {
	*GetBucketTaggingOutput
	// contains filtered or unexported fields
}

GetBucketTaggingResponse is the response type for the GetBucketTagging API operation.

func (*GetBucketTaggingResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketTaggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketTagging request.

type GetBucketVersioningInput

type GetBucketVersioningInput struct {

	// The name of the bucket for which to get the versioning information.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketVersioningInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketVersioningInput) String

func (s GetBucketVersioningInput) String() string

String returns the string representation

func (*GetBucketVersioningInput) Validate

func (s *GetBucketVersioningInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketVersioningOutput

type GetBucketVersioningOutput struct {

	// Specifies whether MFA delete is enabled in the bucket versioning configuration.
	// This element is only returned if the bucket has been configured with MFA
	// delete. If the bucket has never been so configured, this element is not returned.
	MFADelete MFADeleteStatus `locationName:"MfaDelete" type:"string" enum:"true"`

	// The versioning state of the bucket.
	Status BucketVersioningStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetBucketVersioningOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketVersioningOutput) String

func (s GetBucketVersioningOutput) String() string

String returns the string representation

type GetBucketVersioningRequest

type GetBucketVersioningRequest struct {
	*aws.Request
	Input *GetBucketVersioningInput
	Copy  func(*GetBucketVersioningInput) GetBucketVersioningRequest
}

GetBucketVersioningRequest is the request type for the GetBucketVersioning API operation.

func (GetBucketVersioningRequest) Send

Send marshals and sends the GetBucketVersioning API request.

type GetBucketVersioningResponse added in v0.9.0

type GetBucketVersioningResponse struct {
	*GetBucketVersioningOutput
	// contains filtered or unexported fields
}

GetBucketVersioningResponse is the response type for the GetBucketVersioning API operation.

func (*GetBucketVersioningResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketVersioningResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketVersioning request.

type GetBucketWebsiteInput

type GetBucketWebsiteInput struct {

	// The bucket name for which to get the website configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketWebsiteInput) MarshalFields added in v0.3.0

func (s GetBucketWebsiteInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketWebsiteInput) String

func (s GetBucketWebsiteInput) String() string

String returns the string representation

func (*GetBucketWebsiteInput) Validate

func (s *GetBucketWebsiteInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketWebsiteOutput

type GetBucketWebsiteOutput struct {

	// The object key name of the website error document to use for 4XX class errors.
	ErrorDocument *ErrorDocument `type:"structure"`

	// The name of the index document for the website (for example index.html).
	IndexDocument *IndexDocument `type:"structure"`

	// Specifies the redirect behavior of all requests to a website endpoint of
	// an Amazon S3 bucket.
	RedirectAllRequestsTo *RedirectAllRequestsTo `type:"structure"`

	// Rules that define when a redirect is applied and the redirect behavior.
	RoutingRules []RoutingRule `locationNameList:"RoutingRule" type:"list"`
	// contains filtered or unexported fields
}

func (GetBucketWebsiteOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBucketWebsiteOutput) String

func (s GetBucketWebsiteOutput) String() string

String returns the string representation

type GetBucketWebsiteRequest

type GetBucketWebsiteRequest struct {
	*aws.Request
	Input *GetBucketWebsiteInput
	Copy  func(*GetBucketWebsiteInput) GetBucketWebsiteRequest
}

GetBucketWebsiteRequest is the request type for the GetBucketWebsite API operation.

func (GetBucketWebsiteRequest) Send

Send marshals and sends the GetBucketWebsite API request.

type GetBucketWebsiteResponse added in v0.9.0

type GetBucketWebsiteResponse struct {
	*GetBucketWebsiteOutput
	// contains filtered or unexported fields
}

GetBucketWebsiteResponse is the response type for the GetBucketWebsite API operation.

func (*GetBucketWebsiteResponse) SDKResponseMetdata added in v0.9.0

func (r *GetBucketWebsiteResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBucketWebsite request.

type GetObjectAclInput

type GetObjectAclInput struct {

	// The bucket name that contains the object for which to get the ACL information.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The key of the object for which to get the ACL information.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// VersionId used to reference a specific version of the object.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectAclInput) MarshalFields added in v0.3.0

func (s GetObjectAclInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectAclInput) String

func (s GetObjectAclInput) String() string

String returns the string representation

func (*GetObjectAclInput) Validate

func (s *GetObjectAclInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectAclOutput

type GetObjectAclOutput struct {

	// A list of grants.
	Grants []Grant `locationName:"AccessControlList" locationNameList:"Grant" type:"list"`

	// Container for the bucket owner's display name and ID.
	Owner *Owner `type:"structure"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetObjectAclOutput) MarshalFields added in v0.3.0

func (s GetObjectAclOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectAclOutput) String

func (s GetObjectAclOutput) String() string

String returns the string representation

type GetObjectAclRequest

type GetObjectAclRequest struct {
	*aws.Request
	Input *GetObjectAclInput
	Copy  func(*GetObjectAclInput) GetObjectAclRequest
}

GetObjectAclRequest is the request type for the GetObjectAcl API operation.

func (GetObjectAclRequest) Send

Send marshals and sends the GetObjectAcl API request.

type GetObjectAclResponse added in v0.9.0

type GetObjectAclResponse struct {
	*GetObjectAclOutput
	// contains filtered or unexported fields
}

GetObjectAclResponse is the response type for the GetObjectAcl API operation.

func (*GetObjectAclResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectAclResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObjectAcl request.

type GetObjectInput

type GetObjectInput struct {

	// The bucket name containing the object.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Return the object only if its entity tag (ETag) is the same as the one specified,
	// otherwise return a 412 (precondition failed).
	IfMatch *string `location:"header" locationName:"If-Match" type:"string"`

	// Return the object only if it has been modified since the specified time,
	// otherwise return a 304 (not modified).
	IfModifiedSince *time.Time `location:"header" locationName:"If-Modified-Since" type:"timestamp"`

	// Return the object only if its entity tag (ETag) is different from the one
	// specified, otherwise return a 304 (not modified).
	IfNoneMatch *string `location:"header" locationName:"If-None-Match" type:"string"`

	// Return the object only if it has not been modified since the specified time,
	// otherwise return a 412 (precondition failed).
	IfUnmodifiedSince *time.Time `location:"header" locationName:"If-Unmodified-Since" type:"timestamp"`

	// Key of the object to get.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Part number of the object being read. This is a positive integer between
	// 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified.
	// Useful for downloading just a part of an object.
	PartNumber *int64 `location:"querystring" locationName:"partNumber" type:"integer"`

	// Downloads the specified range bytes of an object. For more information about
	// the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
	// (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
	//
	// Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
	Range *string `location:"header" locationName:"Range" type:"string"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Sets the Cache-Control header of the response.
	ResponseCacheControl *string `location:"querystring" locationName:"response-cache-control" type:"string"`

	// Sets the Content-Disposition header of the response
	ResponseContentDisposition *string `location:"querystring" locationName:"response-content-disposition" type:"string"`

	// Sets the Content-Encoding header of the response.
	ResponseContentEncoding *string `location:"querystring" locationName:"response-content-encoding" type:"string"`

	// Sets the Content-Language header of the response.
	ResponseContentLanguage *string `location:"querystring" locationName:"response-content-language" type:"string"`

	// Sets the Content-Type header of the response.
	ResponseContentType *string `location:"querystring" locationName:"response-content-type" type:"string"`

	// Sets the Expires header of the response.
	ResponseExpires *time.Time `location:"querystring" locationName:"response-expires" type:"timestamp"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// VersionId used to reference a specific version of the object.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectInput) MarshalFields added in v0.3.0

func (s GetObjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectInput) String

func (s GetObjectInput) String() string

String returns the string representation

func (*GetObjectInput) Validate

func (s *GetObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectLegalHoldInput added in v0.6.0

type GetObjectLegalHoldInput struct {

	// The bucket name containing the object whose Legal Hold status you want to
	// retrieve.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The key name for the object whose Legal Hold status you want to retrieve.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// The version ID of the object whose Legal Hold status you want to retrieve.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectLegalHoldInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectLegalHoldInput) String added in v0.6.0

func (s GetObjectLegalHoldInput) String() string

String returns the string representation

func (*GetObjectLegalHoldInput) Validate added in v0.6.0

func (s *GetObjectLegalHoldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectLegalHoldOutput added in v0.6.0

type GetObjectLegalHoldOutput struct {

	// The current Legal Hold status for the specified object.
	LegalHold *ObjectLockLegalHold `type:"structure"`
	// contains filtered or unexported fields
}

func (GetObjectLegalHoldOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectLegalHoldOutput) String added in v0.6.0

func (s GetObjectLegalHoldOutput) String() string

String returns the string representation

type GetObjectLegalHoldRequest added in v0.6.0

type GetObjectLegalHoldRequest struct {
	*aws.Request
	Input *GetObjectLegalHoldInput
	Copy  func(*GetObjectLegalHoldInput) GetObjectLegalHoldRequest
}

GetObjectLegalHoldRequest is the request type for the GetObjectLegalHold API operation.

func (GetObjectLegalHoldRequest) Send added in v0.6.0

Send marshals and sends the GetObjectLegalHold API request.

type GetObjectLegalHoldResponse added in v0.9.0

type GetObjectLegalHoldResponse struct {
	*GetObjectLegalHoldOutput
	// contains filtered or unexported fields
}

GetObjectLegalHoldResponse is the response type for the GetObjectLegalHold API operation.

func (*GetObjectLegalHoldResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectLegalHoldResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObjectLegalHold request.

type GetObjectLockConfigurationInput added in v0.6.0

type GetObjectLockConfigurationInput struct {

	// The bucket whose Object Lock configuration you want to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetObjectLockConfigurationInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectLockConfigurationInput) String added in v0.6.0

String returns the string representation

func (*GetObjectLockConfigurationInput) Validate added in v0.6.0

func (s *GetObjectLockConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectLockConfigurationOutput added in v0.6.0

type GetObjectLockConfigurationOutput struct {

	// The specified bucket's Object Lock configuration.
	ObjectLockConfiguration *ObjectLockConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetObjectLockConfigurationOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectLockConfigurationOutput) String added in v0.6.0

String returns the string representation

type GetObjectLockConfigurationRequest added in v0.6.0

type GetObjectLockConfigurationRequest struct {
	*aws.Request
	Input *GetObjectLockConfigurationInput
	Copy  func(*GetObjectLockConfigurationInput) GetObjectLockConfigurationRequest
}

GetObjectLockConfigurationRequest is the request type for the GetObjectLockConfiguration API operation.

func (GetObjectLockConfigurationRequest) Send added in v0.6.0

Send marshals and sends the GetObjectLockConfiguration API request.

type GetObjectLockConfigurationResponse added in v0.9.0

type GetObjectLockConfigurationResponse struct {
	*GetObjectLockConfigurationOutput
	// contains filtered or unexported fields
}

GetObjectLockConfigurationResponse is the response type for the GetObjectLockConfiguration API operation.

func (*GetObjectLockConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectLockConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObjectLockConfiguration request.

type GetObjectOutput

type GetObjectOutput struct {

	// Indicates that a range of bytes was specified.
	AcceptRanges *string `location:"header" locationName:"accept-ranges" type:"string"`

	// Object data.
	Body io.ReadCloser `type:"blob"`

	// Specifies caching behavior along the request/reply chain.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// Specifies presentational information for the object.
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// Specifies what content encodings have been applied to the object and thus
	// what decoding mechanisms must be applied to obtain the media-type referenced
	// by the Content-Type header field.
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The language the content is in.
	ContentLanguage *string `location:"header" locationName:"Content-Language" type:"string"`

	// Size of the body in bytes.
	ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

	// The portion of the object returned in the response.
	ContentRange *string `location:"header" locationName:"Content-Range" type:"string"`

	// A standard MIME type describing the format of the object data.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// Specifies whether the object retrieved was (true) or was not (false) a Delete
	// Marker. If false, this response header does not appear in the response.
	DeleteMarker *bool `location:"header" locationName:"x-amz-delete-marker" type:"boolean"`

	// An ETag is an opaque identifier assigned by a web server to a specific version
	// of a resource found at a URL.
	ETag *string `location:"header" locationName:"ETag" type:"string"`

	// If the object expiration is configured (see PUT Bucket lifecycle), the response
	// includes this header. It includes the expiry-date and rule-id key-value pairs
	// providing object expiration information. The value of the rule-id is URL
	// encoded.
	Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`

	// The date and time at which the object is no longer cacheable.
	Expires *string `location:"header" locationName:"Expires" type:"string"`

	// Last modified date of the object
	LastModified *time.Time `location:"header" locationName:"Last-Modified" type:"timestamp"`

	// A map of metadata to store with the object in S3.
	Metadata map[string]string `location:"headers" locationName:"x-amz-meta-" type:"map"`

	// This is set to the number of metadata entries not returned in x-amz-meta
	// headers. This can happen if you create metadata using an API like SOAP that
	// supports more flexible metadata than the REST API. For example, using SOAP,
	// you can create metadata whose values are not legal HTTP headers.
	MissingMeta *int64 `location:"header" locationName:"x-amz-missing-meta" type:"integer"`

	// Indicates whether this object has an active legal hold. This field is only
	// returned if you have permission to view an object's legal hold status.
	ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"true"`

	// The Object Lock mode currently in place for this object.
	ObjectLockMode ObjectLockMode `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"true"`

	// The date and time when this object's Object Lock will expire.
	ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

	// The count of parts this object has.
	PartsCount *int64 `location:"header" locationName:"x-amz-mp-parts-count" type:"integer"`

	// Amazon S3 can return this if your request involves a bucket that is either
	// a source or destination in a replication rule.
	ReplicationStatus ReplicationStatus `location:"header" locationName:"x-amz-replication-status" type:"string" enum:"true"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// Provides information about object restoration operation and expiration time
	// of the restored object copy.
	Restore *string `location:"header" locationName:"x-amz-restore" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// Provides storage class information of the object. Amazon S3 returns this
	// header for all objects except for S3 Standard storage class objects.
	StorageClass StorageClass `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"true"`

	// The number of tags, if any, on the object.
	TagCount *int64 `location:"header" locationName:"x-amz-tagging-count" type:"integer"`

	// Version of the object.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`

	// If the bucket is configured as a website, redirects requests for this object
	// to another object in the same bucket or to an external URL. Amazon S3 stores
	// the value of this header in the object metadata.
	WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectOutput) MarshalFields added in v0.3.0

func (s GetObjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectOutput) String

func (s GetObjectOutput) String() string

String returns the string representation

type GetObjectRequest

type GetObjectRequest struct {
	*aws.Request
	Input *GetObjectInput
	Copy  func(*GetObjectInput) GetObjectRequest
}

GetObjectRequest is the request type for the GetObject API operation.

func (GetObjectRequest) Send

Send marshals and sends the GetObject API request.

type GetObjectResponse added in v0.9.0

type GetObjectResponse struct {
	*GetObjectOutput
	// contains filtered or unexported fields
}

GetObjectResponse is the response type for the GetObject API operation.

func (*GetObjectResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObject request.

type GetObjectRetentionInput added in v0.6.0

type GetObjectRetentionInput struct {

	// The bucket name containing the object whose retention settings you want to
	// retrieve.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The key name for the object whose retention settings you want to retrieve.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// The version ID for the object whose retention settings you want to retrieve.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectRetentionInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectRetentionInput) String added in v0.6.0

func (s GetObjectRetentionInput) String() string

String returns the string representation

func (*GetObjectRetentionInput) Validate added in v0.6.0

func (s *GetObjectRetentionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectRetentionOutput added in v0.6.0

type GetObjectRetentionOutput struct {

	// The container element for an object's retention settings.
	Retention *ObjectLockRetention `type:"structure"`
	// contains filtered or unexported fields
}

func (GetObjectRetentionOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectRetentionOutput) String added in v0.6.0

func (s GetObjectRetentionOutput) String() string

String returns the string representation

type GetObjectRetentionRequest added in v0.6.0

type GetObjectRetentionRequest struct {
	*aws.Request
	Input *GetObjectRetentionInput
	Copy  func(*GetObjectRetentionInput) GetObjectRetentionRequest
}

GetObjectRetentionRequest is the request type for the GetObjectRetention API operation.

func (GetObjectRetentionRequest) Send added in v0.6.0

Send marshals and sends the GetObjectRetention API request.

type GetObjectRetentionResponse added in v0.9.0

type GetObjectRetentionResponse struct {
	*GetObjectRetentionOutput
	// contains filtered or unexported fields
}

GetObjectRetentionResponse is the response type for the GetObjectRetention API operation.

func (*GetObjectRetentionResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectRetentionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObjectRetention request.

type GetObjectTaggingInput

type GetObjectTaggingInput struct {

	// The bucket name containing the object for which to get the tagging information.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Object key for which to get the tagging information.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// The versionId of the object for which to get the tagging information.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectTaggingInput) MarshalFields added in v0.3.0

func (s GetObjectTaggingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectTaggingInput) String

func (s GetObjectTaggingInput) String() string

String returns the string representation

func (*GetObjectTaggingInput) Validate

func (s *GetObjectTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectTaggingOutput

type GetObjectTaggingOutput struct {

	// Contains the tag set.
	//
	// TagSet is a required field
	TagSet []Tag `locationNameList:"Tag" type:"list" required:"true"`

	// The versionId of the object for which you got the tagging information.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectTaggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectTaggingOutput) String

func (s GetObjectTaggingOutput) String() string

String returns the string representation

type GetObjectTaggingRequest

type GetObjectTaggingRequest struct {
	*aws.Request
	Input *GetObjectTaggingInput
	Copy  func(*GetObjectTaggingInput) GetObjectTaggingRequest
}

GetObjectTaggingRequest is the request type for the GetObjectTagging API operation.

func (GetObjectTaggingRequest) Send

Send marshals and sends the GetObjectTagging API request.

type GetObjectTaggingResponse added in v0.9.0

type GetObjectTaggingResponse struct {
	*GetObjectTaggingOutput
	// contains filtered or unexported fields
}

GetObjectTaggingResponse is the response type for the GetObjectTagging API operation.

func (*GetObjectTaggingResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectTaggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObjectTagging request.

type GetObjectTorrentInput

type GetObjectTorrentInput struct {

	// The name of the bucket containing the object for which to get the torrent
	// files.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The object key for which to get the information.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetObjectTorrentInput) MarshalFields added in v0.3.0

func (s GetObjectTorrentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectTorrentInput) String

func (s GetObjectTorrentInput) String() string

String returns the string representation

func (*GetObjectTorrentInput) Validate

func (s *GetObjectTorrentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectTorrentOutput

type GetObjectTorrentOutput struct {

	// A Bencoded dictionary as defined by the BitTorrent specification
	Body io.ReadCloser `type:"blob"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetObjectTorrentOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetObjectTorrentOutput) String

func (s GetObjectTorrentOutput) String() string

String returns the string representation

type GetObjectTorrentRequest

type GetObjectTorrentRequest struct {
	*aws.Request
	Input *GetObjectTorrentInput
	Copy  func(*GetObjectTorrentInput) GetObjectTorrentRequest
}

GetObjectTorrentRequest is the request type for the GetObjectTorrent API operation.

func (GetObjectTorrentRequest) Send

Send marshals and sends the GetObjectTorrent API request.

type GetObjectTorrentResponse added in v0.9.0

type GetObjectTorrentResponse struct {
	*GetObjectTorrentOutput
	// contains filtered or unexported fields
}

GetObjectTorrentResponse is the response type for the GetObjectTorrent API operation.

func (*GetObjectTorrentResponse) SDKResponseMetdata added in v0.9.0

func (r *GetObjectTorrentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetObjectTorrent request.

type GetPublicAccessBlockInput added in v0.6.0

type GetPublicAccessBlockInput struct {

	// The name of the Amazon S3 bucket whose PublicAccessBlock configuration you
	// want to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPublicAccessBlockInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPublicAccessBlockInput) String added in v0.6.0

func (s GetPublicAccessBlockInput) String() string

String returns the string representation

func (*GetPublicAccessBlockInput) Validate added in v0.6.0

func (s *GetPublicAccessBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPublicAccessBlockOutput added in v0.6.0

type GetPublicAccessBlockOutput struct {

	// The PublicAccessBlock configuration currently in effect for this Amazon S3
	// bucket.
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPublicAccessBlockOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPublicAccessBlockOutput) String added in v0.6.0

String returns the string representation

type GetPublicAccessBlockRequest added in v0.6.0

type GetPublicAccessBlockRequest struct {
	*aws.Request
	Input *GetPublicAccessBlockInput
	Copy  func(*GetPublicAccessBlockInput) GetPublicAccessBlockRequest
}

GetPublicAccessBlockRequest is the request type for the GetPublicAccessBlock API operation.

func (GetPublicAccessBlockRequest) Send added in v0.6.0

Send marshals and sends the GetPublicAccessBlock API request.

type GetPublicAccessBlockResponse added in v0.9.0

type GetPublicAccessBlockResponse struct {
	*GetPublicAccessBlockOutput
	// contains filtered or unexported fields
}

GetPublicAccessBlockResponse is the response type for the GetPublicAccessBlock API operation.

func (*GetPublicAccessBlockResponse) SDKResponseMetdata added in v0.9.0

func (r *GetPublicAccessBlockResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetPublicAccessBlock request.

type GlacierJobParameters

type GlacierJobParameters struct {

	// S3 Glacier retrieval tier at which the restore will be processed.
	//
	// Tier is a required field
	Tier Tier `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Container for S3 Glacier job parameters.

func (GlacierJobParameters) MarshalFields added in v0.3.0

func (s GlacierJobParameters) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GlacierJobParameters) String

func (s GlacierJobParameters) String() string

String returns the string representation

func (*GlacierJobParameters) Validate

func (s *GlacierJobParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Grant

type Grant struct {

	// The person being granted permissions.
	Grantee *Grantee `type:"structure" xmlPrefix:"xsi" xmlURI:"http://www.w3.org/2001/XMLSchema-instance"`

	// Specifies the permission given to the grantee.
	Permission Permission `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Container for grant information.

func (Grant) MarshalFields added in v0.3.0

func (s Grant) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Grant) String

func (s Grant) String() string

String returns the string representation

func (*Grant) Validate

func (s *Grant) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Grantee

type Grantee struct {

	// Screen name of the grantee.
	DisplayName *string `type:"string"`

	// Email address of the grantee.
	//
	// Using email addresses to specify a grantee is only supported in the following
	// AWS Regions:
	//
	//    * US East (N. Virginia)
	//
	//    * US West (N. California)
	//
	//    * US West (Oregon)
	//
	//    * Asia Pacific (Singapore)
	//
	//    * Asia Pacific (Sydney)
	//
	//    * Asia Pacific (Tokyo)
	//
	//    * Europe (Ireland)
	//
	//    * South America (São Paulo)
	//
	// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
	// and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
	// in the AWS General Reference.
	EmailAddress *string `type:"string"`

	// The canonical user ID of the grantee.
	ID *string `type:"string"`

	// Type of grantee
	//
	// Type is a required field
	Type Type `locationName:"xsi:type" type:"string" xmlAttribute:"true" required:"true" enum:"true"`

	// URI of the grantee group.
	URI *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the person being granted permissions.

func (Grantee) MarshalFields added in v0.3.0

func (s Grantee) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Grantee) String

func (s Grantee) String() string

String returns the string representation

func (*Grantee) Validate

func (s *Grantee) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HeadBucketInput

type HeadBucketInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (HeadBucketInput) MarshalFields added in v0.3.0

func (s HeadBucketInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HeadBucketInput) String

func (s HeadBucketInput) String() string

String returns the string representation

func (*HeadBucketInput) Validate

func (s *HeadBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HeadBucketOutput

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

func (HeadBucketOutput) MarshalFields added in v0.3.0

func (s HeadBucketOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HeadBucketOutput) String

func (s HeadBucketOutput) String() string

String returns the string representation

type HeadBucketRequest

type HeadBucketRequest struct {
	*aws.Request
	Input *HeadBucketInput
	Copy  func(*HeadBucketInput) HeadBucketRequest
}

HeadBucketRequest is the request type for the HeadBucket API operation.

func (HeadBucketRequest) Send

Send marshals and sends the HeadBucket API request.

type HeadBucketResponse added in v0.9.0

type HeadBucketResponse struct {
	*HeadBucketOutput
	// contains filtered or unexported fields
}

HeadBucketResponse is the response type for the HeadBucket API operation.

func (*HeadBucketResponse) SDKResponseMetdata added in v0.9.0

func (r *HeadBucketResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the HeadBucket request.

type HeadObjectInput

type HeadObjectInput struct {

	// The name of the bucket containing the object.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Return the object only if its entity tag (ETag) is the same as the one specified,
	// otherwise return a 412 (precondition failed).
	IfMatch *string `location:"header" locationName:"If-Match" type:"string"`

	// Return the object only if it has been modified since the specified time,
	// otherwise return a 304 (not modified).
	IfModifiedSince *time.Time `location:"header" locationName:"If-Modified-Since" type:"timestamp"`

	// Return the object only if its entity tag (ETag) is different from the one
	// specified, otherwise return a 304 (not modified).
	IfNoneMatch *string `location:"header" locationName:"If-None-Match" type:"string"`

	// Return the object only if it has not been modified since the specified time,
	// otherwise return a 412 (precondition failed).
	IfUnmodifiedSince *time.Time `location:"header" locationName:"If-Unmodified-Since" type:"timestamp"`

	// The object key.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Part number of the object being read. This is a positive integer between
	// 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified.
	// Useful querying about the size of the part and the number of parts in this
	// object.
	PartNumber *int64 `location:"querystring" locationName:"partNumber" type:"integer"`

	// Downloads the specified range bytes of an object. For more information about
	// the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
	//
	// Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
	Range *string `location:"header" locationName:"Range" type:"string"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// VersionId used to reference a specific version of the object.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (HeadObjectInput) MarshalFields added in v0.3.0

func (s HeadObjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HeadObjectInput) String

func (s HeadObjectInput) String() string

String returns the string representation

func (*HeadObjectInput) Validate

func (s *HeadObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HeadObjectOutput

type HeadObjectOutput struct {

	// Indicates that a range of bytes was specified.
	AcceptRanges *string `location:"header" locationName:"accept-ranges" type:"string"`

	// Specifies caching behavior along the request/reply chain.
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// Specifies presentational information for the object.
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// Specifies what content encodings have been applied to the object and thus
	// what decoding mechanisms must be applied to obtain the media-type referenced
	// by the Content-Type header field.
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The language the content is in.
	ContentLanguage *string `location:"header" locationName:"Content-Language" type:"string"`

	// Size of the body in bytes.
	ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

	// A standard MIME type describing the format of the object data.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// Specifies whether the object retrieved was (true) or was not (false) a Delete
	// Marker. If false, this response header does not appear in the response.
	DeleteMarker *bool `location:"header" locationName:"x-amz-delete-marker" type:"boolean"`

	// An ETag is an opaque identifier assigned by a web server to a specific version
	// of a resource found at a URL.
	ETag *string `location:"header" locationName:"ETag" type:"string"`

	// If the object expiration is configured (see PUT Bucket lifecycle), the response
	// includes this header. It includes the expiry-date and rule-id key-value pairs
	// providing object expiration information. The value of the rule-id is URL
	// encoded.
	Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`

	// The date and time at which the object is no longer cacheable.
	Expires *string `location:"header" locationName:"Expires" type:"string"`

	// Last modified date of the object
	LastModified *time.Time `location:"header" locationName:"Last-Modified" type:"timestamp"`

	// A map of metadata to store with the object in S3.
	Metadata map[string]string `location:"headers" locationName:"x-amz-meta-" type:"map"`

	// This is set to the number of metadata entries not returned in x-amz-meta
	// headers. This can happen if you create metadata using an API like SOAP that
	// supports more flexible metadata than the REST API. For example, using SOAP,
	// you can create metadata whose values are not legal HTTP headers.
	MissingMeta *int64 `location:"header" locationName:"x-amz-missing-meta" type:"integer"`

	// Specifies whether a legal hold is in effect for this object. This header
	// is only returned if the requester has the s3:GetObjectLegalHold permission.
	// This header is not returned if the specified version of this object has never
	// had a legal hold applied. For more information about S3 Object Lock, see
	// Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
	ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"true"`

	// The Object Lock mode, if any, that's in effect for this object. This header
	// is only returned if the requester has the s3:GetObjectRetention permission.
	// For more information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
	ObjectLockMode ObjectLockMode `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"true"`

	// The date and time when the Object Lock retention period expires. This header
	// is only returned if the requester has the s3:GetObjectRetention permission.
	ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

	// The count of parts this object has.
	PartsCount *int64 `location:"header" locationName:"x-amz-mp-parts-count" type:"integer"`

	// Amazon S3 can return this header if your request involves a bucket that is
	// either a source or destination in a replication rule.
	//
	// In replication, you have a source bucket on which you configure replication
	// and destination bucket where Amazon S3 stores object replicas. When you request
	// an object (GetObject) or object metadata (HeadObject) from these buckets,
	// Amazon S3 will return the x-amz-replication-status header in the response
	// as follows:
	//
	//    * If requesting an object from the source bucket — Amazon S3 will return
	//    the x-amz-replication-status header if the object in your request is eligible
	//    for replication. For example, suppose that in your replication configuration,
	//    you specify object prefix TaxDocs requesting Amazon S3 to replicate objects
	//    with key prefix TaxDocs. Any objects you upload with this key name prefix,
	//    for example TaxDocs/document1.pdf, are eligible for replication. For any
	//    object request with this key name prefix, Amazon S3 will return the x-amz-replication-status
	//    header with value PENDING, COMPLETED or FAILED indicating object replication
	//    status.
	//
	//    * If requesting an object from the destination bucket — Amazon S3 will
	//    return the x-amz-replication-status header with value REPLICA if the object
	//    in your request is a replica that Amazon S3 created.
	//
	// For more information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
	ReplicationStatus ReplicationStatus `location:"header" locationName:"x-amz-replication-status" type:"string" enum:"true"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If the object is an archived object (an object whose storage class is GLACIER),
	// the response includes this header if either the archive restoration is in
	// progress (see RestoreObject or an archive copy is already restored.
	//
	// If an archive copy is already restored, the header value indicates when Amazon
	// S3 is scheduled to delete the object copy. For example:
	//
	// x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec 2012 00:00:00
	// GMT"
	//
	// If the object restoration is in progress, the header returns the value ongoing-request="true".
	//
	// For more information about archiving objects, see Transitioning Objects:
	// General Considerations (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations).
	Restore *string `location:"header" locationName:"x-amz-restore" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// If the object is stored using server-side encryption either with an AWS KMS
	// customer master key (CMK) or an Amazon S3-managed encryption key, the response
	// includes this header with the value of the server-side encryption algorithm
	// used when storing this object in Amazon S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// Provides storage class information of the object. Amazon S3 returns this
	// header for all objects except for S3 Standard storage class objects.
	//
	// For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).
	StorageClass StorageClass `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"true"`

	// Version of the object.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`

	// If the bucket is configured as a website, redirects requests for this object
	// to another object in the same bucket or to an external URL. Amazon S3 stores
	// the value of this header in the object metadata.
	WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" type:"string"`
	// contains filtered or unexported fields
}

func (HeadObjectOutput) MarshalFields added in v0.3.0

func (s HeadObjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HeadObjectOutput) String

func (s HeadObjectOutput) String() string

String returns the string representation

type HeadObjectRequest

type HeadObjectRequest struct {
	*aws.Request
	Input *HeadObjectInput
	Copy  func(*HeadObjectInput) HeadObjectRequest
}

HeadObjectRequest is the request type for the HeadObject API operation.

func (HeadObjectRequest) Send

Send marshals and sends the HeadObject API request.

type HeadObjectResponse added in v0.9.0

type HeadObjectResponse struct {
	*HeadObjectOutput
	// contains filtered or unexported fields
}

HeadObjectResponse is the response type for the HeadObject API operation.

func (*HeadObjectResponse) SDKResponseMetdata added in v0.9.0

func (r *HeadObjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the HeadObject request.

type IndexDocument

type IndexDocument struct {

	// A suffix that is appended to a request that is for a directory on the website
	// endpoint (for example,if the suffix is index.html and you make a request
	// to samplebucket/images/ the data that is returned will be for the object
	// with the key name images/index.html) The suffix must not be empty and must
	// not include a slash character.
	//
	// Suffix is a required field
	Suffix *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the Suffix element.

func (IndexDocument) MarshalFields added in v0.3.0

func (s IndexDocument) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (IndexDocument) String

func (s IndexDocument) String() string

String returns the string representation

func (*IndexDocument) Validate

func (s *IndexDocument) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Initiator

type Initiator struct {

	// Name of the Principal.
	DisplayName *string `type:"string"`

	// If the principal is an AWS account, it provides the Canonical User ID. If
	// the principal is an IAM User, it provides a user ARN value.
	ID *string `type:"string"`
	// contains filtered or unexported fields
}

Container element that identifies who initiated the multipart upload.

func (Initiator) MarshalFields added in v0.3.0

func (s Initiator) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Initiator) String

func (s Initiator) String() string

String returns the string representation

type InputSerialization added in v0.2.0

type InputSerialization struct {

	// Describes the serialization of a CSV-encoded object.
	CSV *CSVInput `type:"structure"`

	// Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default
	// Value: NONE.
	CompressionType CompressionType `type:"string" enum:"true"`

	// Specifies JSON as object's input serialization format.
	JSON *JSONInput `type:"structure"`

	// Specifies Parquet as object's input serialization format.
	Parquet *ParquetInput `type:"structure"`
	// contains filtered or unexported fields
}

Describes the serialization format of the object.

func (InputSerialization) MarshalFields added in v0.3.0

func (s InputSerialization) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InputSerialization) String added in v0.2.0

func (s InputSerialization) String() string

String returns the string representation

type InventoryConfiguration

type InventoryConfiguration struct {

	// Contains information about where to publish the inventory results.
	//
	// Destination is a required field
	Destination *InventoryDestination `type:"structure" required:"true"`

	// Specifies an inventory filter. The inventory only includes objects that meet
	// the filter's criteria.
	Filter *InventoryFilter `type:"structure"`

	// The ID used to identify the inventory configuration.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// Object versions to include in the inventory list. If set to All, the list
	// includes all the object versions, which adds the version-related fields VersionId,
	// IsLatest, and DeleteMarker to the list. If set to Current, the list does
	// not contain these version-related fields.
	//
	// IncludedObjectVersions is a required field
	IncludedObjectVersions InventoryIncludedObjectVersions `type:"string" required:"true" enum:"true"`

	// Specifies whether the inventory is enabled or disabled. If set to True, an
	// inventory list is generated. If set to False, no inventory list is generated.
	//
	// IsEnabled is a required field
	IsEnabled *bool `type:"boolean" required:"true"`

	// Contains the optional fields that are included in the inventory results.
	OptionalFields []InventoryOptionalField `locationNameList:"Field" type:"list"`

	// Specifies the schedule for generating inventory results.
	//
	// Schedule is a required field
	Schedule *InventorySchedule `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the Amazon Simple Storage Service API Reference.

func (InventoryConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InventoryConfiguration) String

func (s InventoryConfiguration) String() string

String returns the string representation

func (*InventoryConfiguration) Validate

func (s *InventoryConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryDestination

type InventoryDestination struct {

	// Contains the bucket name, file format, bucket owner (optional), and prefix
	// (optional) where inventory results are published.
	//
	// S3BucketDestination is a required field
	S3BucketDestination *InventoryS3BucketDestination `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Specifies the inventory configuration for an Amazon S3 bucket.

func (InventoryDestination) MarshalFields added in v0.3.0

func (s InventoryDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InventoryDestination) String

func (s InventoryDestination) String() string

String returns the string representation

func (*InventoryDestination) Validate

func (s *InventoryDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryEncryption added in v0.2.0

type InventoryEncryption struct {

	// Specifies the use of SSE-KMS to encrypt delivered inventory reports.
	SSEKMS *SSEKMS `locationName:"SSE-KMS" type:"structure"`

	// Specifies the use of SSE-S3 to encrypt delivered inventory reports.
	SSES3 *SSES3 `locationName:"SSE-S3" type:"structure"`
	// contains filtered or unexported fields
}

Contains the type of server-side encryption used to encrypt the inventory results.

func (InventoryEncryption) MarshalFields added in v0.3.0

func (s InventoryEncryption) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InventoryEncryption) String added in v0.2.0

func (s InventoryEncryption) String() string

String returns the string representation

func (*InventoryEncryption) Validate added in v0.2.0

func (s *InventoryEncryption) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryFilter

type InventoryFilter struct {

	// The prefix that an object must have to be included in the inventory results.
	//
	// Prefix is a required field
	Prefix *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

func (InventoryFilter) MarshalFields added in v0.3.0

func (s InventoryFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InventoryFilter) String

func (s InventoryFilter) String() string

String returns the string representation

func (*InventoryFilter) Validate

func (s *InventoryFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryFormat

type InventoryFormat string
const (
	InventoryFormatCsv     InventoryFormat = "CSV"
	InventoryFormatOrc     InventoryFormat = "ORC"
	InventoryFormatParquet InventoryFormat = "Parquet"
)

Enum values for InventoryFormat

func (InventoryFormat) MarshalValue added in v0.3.0

func (enum InventoryFormat) MarshalValue() (string, error)

func (InventoryFormat) MarshalValueBuf added in v0.3.0

func (enum InventoryFormat) MarshalValueBuf(b []byte) ([]byte, error)

type InventoryFrequency

type InventoryFrequency string
const (
	InventoryFrequencyDaily  InventoryFrequency = "Daily"
	InventoryFrequencyWeekly InventoryFrequency = "Weekly"
)

Enum values for InventoryFrequency

func (InventoryFrequency) MarshalValue added in v0.3.0

func (enum InventoryFrequency) MarshalValue() (string, error)

func (InventoryFrequency) MarshalValueBuf added in v0.3.0

func (enum InventoryFrequency) MarshalValueBuf(b []byte) ([]byte, error)

type InventoryIncludedObjectVersions

type InventoryIncludedObjectVersions string
const (
	InventoryIncludedObjectVersionsAll     InventoryIncludedObjectVersions = "All"
	InventoryIncludedObjectVersionsCurrent InventoryIncludedObjectVersions = "Current"
)

Enum values for InventoryIncludedObjectVersions

func (InventoryIncludedObjectVersions) MarshalValue added in v0.3.0

func (enum InventoryIncludedObjectVersions) MarshalValue() (string, error)

func (InventoryIncludedObjectVersions) MarshalValueBuf added in v0.3.0

func (enum InventoryIncludedObjectVersions) MarshalValueBuf(b []byte) ([]byte, error)

type InventoryOptionalField

type InventoryOptionalField string
const (
	InventoryOptionalFieldSize                         InventoryOptionalField = "Size"
	InventoryOptionalFieldLastModifiedDate             InventoryOptionalField = "LastModifiedDate"
	InventoryOptionalFieldStorageClass                 InventoryOptionalField = "StorageClass"
	InventoryOptionalFieldEtag                         InventoryOptionalField = "ETag"
	InventoryOptionalFieldIsMultipartUploaded          InventoryOptionalField = "IsMultipartUploaded"
	InventoryOptionalFieldReplicationStatus            InventoryOptionalField = "ReplicationStatus"
	InventoryOptionalFieldEncryptionStatus             InventoryOptionalField = "EncryptionStatus"
	InventoryOptionalFieldObjectLockRetainUntilDate    InventoryOptionalField = "ObjectLockRetainUntilDate"
	InventoryOptionalFieldObjectLockMode               InventoryOptionalField = "ObjectLockMode"
	InventoryOptionalFieldObjectLockLegalHoldStatus    InventoryOptionalField = "ObjectLockLegalHoldStatus"
	InventoryOptionalFieldIntelligentTieringAccessTier InventoryOptionalField = "IntelligentTieringAccessTier"
)

Enum values for InventoryOptionalField

func (InventoryOptionalField) MarshalValue added in v0.3.0

func (enum InventoryOptionalField) MarshalValue() (string, error)

func (InventoryOptionalField) MarshalValueBuf added in v0.3.0

func (enum InventoryOptionalField) MarshalValueBuf(b []byte) ([]byte, error)

type InventoryS3BucketDestination

type InventoryS3BucketDestination struct {

	// The account ID that owns the destination S3 bucket. If no account ID is provided,
	// the owner is not validated before exporting data.
	//
	// Although this value is optional, we strongly recommend that you set it to
	// help prevent problems if the destination bucket ownership changes.
	AccountId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the bucket where inventory results will
	// be published.
	//
	// Bucket is a required field
	Bucket *string `type:"string" required:"true"`

	// Contains the type of server-side encryption used to encrypt the inventory
	// results.
	Encryption *InventoryEncryption `type:"structure"`

	// Specifies the output format of the inventory results.
	//
	// Format is a required field
	Format InventoryFormat `type:"string" required:"true" enum:"true"`

	// The prefix that is prepended to all inventory results.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

func (InventoryS3BucketDestination) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InventoryS3BucketDestination) String

String returns the string representation

func (*InventoryS3BucketDestination) Validate

func (s *InventoryS3BucketDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventorySchedule

type InventorySchedule struct {

	// Specifies how frequently inventory results are produced.
	//
	// Frequency is a required field
	Frequency InventoryFrequency `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the schedule for generating inventory results.

func (InventorySchedule) MarshalFields added in v0.3.0

func (s InventorySchedule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InventorySchedule) String

func (s InventorySchedule) String() string

String returns the string representation

func (*InventorySchedule) Validate

func (s *InventorySchedule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JSONInput added in v0.4.0

type JSONInput struct {

	// The type of JSON. Valid values: Document, Lines.
	Type JSONType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies JSON as object's input serialization format.

func (JSONInput) MarshalFields added in v0.4.0

func (s JSONInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JSONInput) String added in v0.4.0

func (s JSONInput) String() string

String returns the string representation

type JSONOutput added in v0.4.0

type JSONOutput struct {

	// The value used to separate individual records in the output. If no value
	// is specified, Amazon S3 uses a newline character ('\n').
	RecordDelimiter *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies JSON as request's output serialization format.

func (JSONOutput) MarshalFields added in v0.4.0

func (s JSONOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JSONOutput) String added in v0.4.0

func (s JSONOutput) String() string

String returns the string representation

type JSONType added in v0.4.0

type JSONType string
const (
	JSONTypeDocument JSONType = "DOCUMENT"
	JSONTypeLines    JSONType = "LINES"
)

Enum values for JSONType

func (JSONType) MarshalValue added in v0.4.0

func (enum JSONType) MarshalValue() (string, error)

func (JSONType) MarshalValueBuf added in v0.4.0

func (enum JSONType) MarshalValueBuf(b []byte) ([]byte, error)

type LambdaFunctionConfiguration

type LambdaFunctionConfiguration struct {

	// The Amazon S3 bucket event for which to invoke the AWS Lambda function. For
	// more information, see Supported Event Types (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Events is a required field
	Events []Event `locationName:"Event" type:"list" flattened:"true" required:"true"`

	// Specifies object key name filtering rules. For information about key name
	// filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Filter *NotificationConfigurationFilter `type:"structure"`

	// An optional unique identifier for configurations in a notification configuration.
	// If you don't provide one, Amazon S3 will assign an ID.
	Id *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3
	// invokes when the specified event type occurs.
	//
	// LambdaFunctionArn is a required field
	LambdaFunctionArn *string `locationName:"CloudFunction" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A container for specifying the configuration for AWS Lambda notifications.

func (LambdaFunctionConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LambdaFunctionConfiguration) String

String returns the string representation

func (*LambdaFunctionConfiguration) Validate

func (s *LambdaFunctionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleConfiguration

type LifecycleConfiguration struct {

	// Specifies lifecycle configuration rules for an Amazon S3 bucket.
	//
	// Rules is a required field
	Rules []Rule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

Container for lifecycle rules. You can add as many as 1000 rules.

func (LifecycleConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecycleConfiguration) String

func (s LifecycleConfiguration) String() string

String returns the string representation

func (*LifecycleConfiguration) Validate

func (s *LifecycleConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleExpiration

type LifecycleExpiration struct {

	// Indicates at what date the object is to be moved or deleted. Should be in
	// GMT ISO 8601 Format.
	Date *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Indicates the lifetime, in days, of the objects that are subject to the rule.
	// The value must be a non-zero positive integer.
	Days *int64 `type:"integer"`

	// Indicates whether Amazon S3 will remove a delete marker with no noncurrent
	// versions. If set to true, the delete marker will be expired; if set to false
	// the policy takes no action. This cannot be specified with Days or Date in
	// a Lifecycle Expiration Policy.
	ExpiredObjectDeleteMarker *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Container for the expiration for the lifecycle of the object.

func (LifecycleExpiration) MarshalFields added in v0.3.0

func (s LifecycleExpiration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecycleExpiration) String

func (s LifecycleExpiration) String() string

String returns the string representation

type LifecycleRule

type LifecycleRule struct {

	// Specifies the days since the initiation of an incomplete multipart upload
	// that Amazon S3 will wait before permanently removing all parts of the upload.
	// For more information, see Aborting Incomplete Multipart Uploads Using a Bucket
	// Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config)
	// in the Amazon Simple Storage Service Developer Guide.
	AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload `type:"structure"`

	// Specifies the expiration for the lifecycle of the object in the form of date,
	// days and, whether the object has a delete marker.
	Expiration *LifecycleExpiration `type:"structure"`

	// The Filter is used to identify objects that a Lifecycle Rule applies to.
	// A Filter must have exactly one of Prefix, Tag, or And specified.
	Filter *LifecycleRuleFilter `type:"structure"`

	// Unique identifier for the rule. The value cannot be longer than 255 characters.
	ID *string `type:"string"`

	// 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.
	NoncurrentVersionExpiration *NoncurrentVersionExpiration `type:"structure"`

	// Specifies the transition rule for the lifecycle rule that describes when
	// noncurrent objects transition to a specific 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 a specific
	// storage class at a set period in the object's lifetime.
	NoncurrentVersionTransitions []NoncurrentVersionTransition `locationName:"NoncurrentVersionTransition" type:"list" flattened:"true"`

	// Prefix identifying one or more objects to which the rule applies. This is
	// No longer used; use Filter instead.
	Prefix *string `deprecated:"true" type:"string"`

	// If 'Enabled', the rule is currently being applied. If 'Disabled', the rule
	// is not currently being applied.
	//
	// Status is a required field
	Status ExpirationStatus `type:"string" required:"true" enum:"true"`

	// Specifies when an Amazon S3 object transitions to a specified storage class.
	Transitions []Transition `locationName:"Transition" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

A lifecycle rule for individual objects in an Amazon S3 bucket.

func (LifecycleRule) MarshalFields added in v0.3.0

func (s LifecycleRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecycleRule) String

func (s LifecycleRule) String() string

String returns the string representation

func (*LifecycleRule) Validate

func (s *LifecycleRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleRuleAndOperator

type LifecycleRuleAndOperator struct {

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string `type:"string"`

	// All of these tags must exist in the object's tag set in order for the rule
	// to apply.
	Tags []Tag `locationName:"Tag" locationNameList:"Tag" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

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.

func (LifecycleRuleAndOperator) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecycleRuleAndOperator) String

func (s LifecycleRuleAndOperator) String() string

String returns the string representation

func (*LifecycleRuleAndOperator) Validate

func (s *LifecycleRuleAndOperator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleRuleFilter

type LifecycleRuleFilter struct {

	// 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.
	And *LifecycleRuleAndOperator `type:"structure"`

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string `type:"string"`

	// This tag must exist in the object's tag set in order for the rule to apply.
	Tag *Tag `type:"structure"`
	// contains filtered or unexported fields
}

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.

func (LifecycleRuleFilter) MarshalFields added in v0.3.0

func (s LifecycleRuleFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecycleRuleFilter) String

func (s LifecycleRuleFilter) String() string

String returns the string representation

func (*LifecycleRuleFilter) Validate

func (s *LifecycleRuleFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBucketAnalyticsConfigurationsInput

type ListBucketAnalyticsConfigurationsInput struct {

	// The name of the bucket from which analytics configurations are retrieved.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ContinuationToken that represents a placeholder from where this request
	// should begin.
	ContinuationToken *string `location:"querystring" locationName:"continuation-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListBucketAnalyticsConfigurationsInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketAnalyticsConfigurationsInput) String

String returns the string representation

func (*ListBucketAnalyticsConfigurationsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListBucketAnalyticsConfigurationsOutput

type ListBucketAnalyticsConfigurationsOutput struct {

	// The list of analytics configurations for a bucket.
	AnalyticsConfigurationList []AnalyticsConfiguration `locationName:"AnalyticsConfiguration" type:"list" flattened:"true"`

	// The marker that is used as a starting point for this analytics configuration
	// list response. This value is present if it was sent in the request.
	ContinuationToken *string `type:"string"`

	// Indicates whether the returned list of analytics configurations is complete.
	// A value of true indicates that the list is not complete and the NextContinuationToken
	// will be provided for a subsequent request.
	IsTruncated *bool `type:"boolean"`

	// NextContinuationToken is sent when isTruncated is true, which indicates that
	// there are more analytics configurations to list. The next request must include
	// this NextContinuationToken. The token is obfuscated and is not a usable value.
	NextContinuationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBucketAnalyticsConfigurationsOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketAnalyticsConfigurationsOutput) String

String returns the string representation

type ListBucketAnalyticsConfigurationsRequest

ListBucketAnalyticsConfigurationsRequest is the request type for the ListBucketAnalyticsConfigurations API operation.

func (ListBucketAnalyticsConfigurationsRequest) Send

Send marshals and sends the ListBucketAnalyticsConfigurations API request.

type ListBucketAnalyticsConfigurationsResponse added in v0.9.0

type ListBucketAnalyticsConfigurationsResponse struct {
	*ListBucketAnalyticsConfigurationsOutput
	// contains filtered or unexported fields
}

ListBucketAnalyticsConfigurationsResponse is the response type for the ListBucketAnalyticsConfigurations API operation.

func (*ListBucketAnalyticsConfigurationsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListBucketAnalyticsConfigurationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListBucketAnalyticsConfigurations request.

type ListBucketInventoryConfigurationsInput

type ListBucketInventoryConfigurationsInput struct {

	// The name of the bucket containing the inventory configurations to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The marker used to continue an inventory configuration listing that has been
	// truncated. Use the NextContinuationToken from a previously truncated list
	// response to continue the listing. The continuation token is an opaque value
	// that Amazon S3 understands.
	ContinuationToken *string `location:"querystring" locationName:"continuation-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListBucketInventoryConfigurationsInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketInventoryConfigurationsInput) String

String returns the string representation

func (*ListBucketInventoryConfigurationsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListBucketInventoryConfigurationsOutput

type ListBucketInventoryConfigurationsOutput struct {

	// If sent in the request, the marker that is used as a starting point for this
	// inventory configuration list response.
	ContinuationToken *string `type:"string"`

	// The list of inventory configurations for a bucket.
	InventoryConfigurationList []InventoryConfiguration `locationName:"InventoryConfiguration" type:"list" flattened:"true"`

	// Tells whether the returned list of inventory configurations is complete.
	// A value of true indicates that the list is not complete and the NextContinuationToken
	// is provided for a subsequent request.
	IsTruncated *bool `type:"boolean"`

	// The marker used to continue this inventory configuration listing. Use the
	// NextContinuationToken from this response to continue the listing in a subsequent
	// request. The continuation token is an opaque value that Amazon S3 understands.
	NextContinuationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBucketInventoryConfigurationsOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketInventoryConfigurationsOutput) String

String returns the string representation

type ListBucketInventoryConfigurationsRequest

ListBucketInventoryConfigurationsRequest is the request type for the ListBucketInventoryConfigurations API operation.

func (ListBucketInventoryConfigurationsRequest) Send

Send marshals and sends the ListBucketInventoryConfigurations API request.

type ListBucketInventoryConfigurationsResponse added in v0.9.0

type ListBucketInventoryConfigurationsResponse struct {
	*ListBucketInventoryConfigurationsOutput
	// contains filtered or unexported fields
}

ListBucketInventoryConfigurationsResponse is the response type for the ListBucketInventoryConfigurations API operation.

func (*ListBucketInventoryConfigurationsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListBucketInventoryConfigurationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListBucketInventoryConfigurations request.

type ListBucketMetricsConfigurationsInput

type ListBucketMetricsConfigurationsInput struct {

	// The name of the bucket containing the metrics configurations to retrieve.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The marker that is used to continue a metrics configuration listing that
	// has been truncated. Use the NextContinuationToken from a previously truncated
	// list response to continue the listing. The continuation token is an opaque
	// value that Amazon S3 understands.
	ContinuationToken *string `location:"querystring" locationName:"continuation-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListBucketMetricsConfigurationsInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketMetricsConfigurationsInput) String

String returns the string representation

func (*ListBucketMetricsConfigurationsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListBucketMetricsConfigurationsOutput

type ListBucketMetricsConfigurationsOutput struct {

	// The marker that is used as a starting point for this metrics configuration
	// list response. This value is present if it was sent in the request.
	ContinuationToken *string `type:"string"`

	// Indicates whether the returned list of metrics configurations is complete.
	// A value of true indicates that the list is not complete and the NextContinuationToken
	// will be provided for a subsequent request.
	IsTruncated *bool `type:"boolean"`

	// The list of metrics configurations for a bucket.
	MetricsConfigurationList []MetricsConfiguration `locationName:"MetricsConfiguration" type:"list" flattened:"true"`

	// The marker used to continue a metrics configuration listing that has been
	// truncated. Use the NextContinuationToken from a previously truncated list
	// response to continue the listing. The continuation token is an opaque value
	// that Amazon S3 understands.
	NextContinuationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBucketMetricsConfigurationsOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketMetricsConfigurationsOutput) String

String returns the string representation

type ListBucketMetricsConfigurationsRequest

type ListBucketMetricsConfigurationsRequest struct {
	*aws.Request
	Input *ListBucketMetricsConfigurationsInput
	Copy  func(*ListBucketMetricsConfigurationsInput) ListBucketMetricsConfigurationsRequest
}

ListBucketMetricsConfigurationsRequest is the request type for the ListBucketMetricsConfigurations API operation.

func (ListBucketMetricsConfigurationsRequest) Send

Send marshals and sends the ListBucketMetricsConfigurations API request.

type ListBucketMetricsConfigurationsResponse added in v0.9.0

type ListBucketMetricsConfigurationsResponse struct {
	*ListBucketMetricsConfigurationsOutput
	// contains filtered or unexported fields
}

ListBucketMetricsConfigurationsResponse is the response type for the ListBucketMetricsConfigurations API operation.

func (*ListBucketMetricsConfigurationsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListBucketMetricsConfigurationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListBucketMetricsConfigurations request.

type ListBucketsInput

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

func (ListBucketsInput) MarshalFields added in v0.3.0

func (s ListBucketsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketsInput) String

func (s ListBucketsInput) String() string

String returns the string representation

type ListBucketsOutput

type ListBucketsOutput struct {

	// The list of buckets owned by the requestor.
	Buckets []Bucket `locationNameList:"Bucket" type:"list"`

	// The owner of the buckets listed.
	Owner *Owner `type:"structure"`
	// contains filtered or unexported fields
}

func (ListBucketsOutput) MarshalFields added in v0.3.0

func (s ListBucketsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBucketsOutput) String

func (s ListBucketsOutput) String() string

String returns the string representation

type ListBucketsRequest

type ListBucketsRequest struct {
	*aws.Request
	Input *ListBucketsInput
	Copy  func(*ListBucketsInput) ListBucketsRequest
}

ListBucketsRequest is the request type for the ListBuckets API operation.

func (ListBucketsRequest) Send

Send marshals and sends the ListBuckets API request.

type ListBucketsResponse added in v0.9.0

type ListBucketsResponse struct {
	*ListBucketsOutput
	// contains filtered or unexported fields
}

ListBucketsResponse is the response type for the ListBuckets API operation.

func (*ListBucketsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListBucketsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListBuckets request.

type ListMultipartUploadsInput

type ListMultipartUploadsInput struct {

	// Name of the bucket to which the multipart upload was initiated.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Character you use to group keys.
	//
	// All keys that contain the same string between the prefix, if specified, and
	// the first occurrence of the delimiter after the prefix are grouped under
	// a single result element, CommonPrefixes. If you don't specify the prefix
	// parameter, then the substring starts at the beginning of the key. The keys
	// that are grouped under CommonPrefixes result element are not returned elsewhere
	// in the response.
	Delimiter *string `location:"querystring" locationName:"delimiter" type:"string"`

	// Requests Amazon S3 to encode the object keys in the response and specifies
	// the encoding method to use. An object key may contain any Unicode character;
	// however, XML 1.0 parser cannot parse some characters, such as characters
	// with an ASCII value from 0 to 10. For characters that are not supported in
	// XML 1.0, you can add this parameter to request that Amazon S3 encode the
	// keys in the response.
	EncodingType EncodingType `location:"querystring" locationName:"encoding-type" type:"string" enum:"true"`

	// Together with upload-id-marker, this parameter specifies the multipart upload
	// after which listing should begin.
	//
	// If upload-id-marker is not specified, only the keys lexicographically greater
	// than the specified key-marker will be included in the list.
	//
	// If upload-id-marker is specified, any multipart uploads for a key equal to
	// the key-marker might also be included, provided those multipart uploads have
	// upload IDs lexicographically greater than the specified upload-id-marker.
	KeyMarker *string `location:"querystring" locationName:"key-marker" type:"string"`

	// Sets the maximum number of multipart uploads, from 1 to 1,000, to return
	// in the response body. 1,000 is the maximum number of uploads that can be
	// returned in a response.
	MaxUploads *int64 `location:"querystring" locationName:"max-uploads" type:"integer"`

	// Lists in-progress uploads only for those keys that begin with the specified
	// prefix. You can use prefixes to separate a bucket into different grouping
	// of keys. (You can think of using prefix to make groups in the same way you'd
	// use a folder in a file system.)
	Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

	// Together with key-marker, specifies the multipart upload after which listing
	// should begin. If key-marker is not specified, the upload-id-marker parameter
	// is ignored. Otherwise, any multipart uploads for a key equal to the key-marker
	// might be included in the list only if they have an upload ID lexicographically
	// greater than the specified upload-id-marker.
	UploadIdMarker *string `location:"querystring" locationName:"upload-id-marker" type:"string"`
	// contains filtered or unexported fields
}

func (ListMultipartUploadsInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListMultipartUploadsInput) String

func (s ListMultipartUploadsInput) String() string

String returns the string representation

func (*ListMultipartUploadsInput) Validate

func (s *ListMultipartUploadsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMultipartUploadsOutput

type ListMultipartUploadsOutput struct {

	// Name of the bucket to which the multipart upload was initiated.
	Bucket *string `type:"string"`

	// If you specify a delimiter in the request, then the result returns each distinct
	// key prefix containing the delimiter in a CommonPrefixes element. The distinct
	// key prefixes are returned in the Prefix child element.
	CommonPrefixes []CommonPrefix `type:"list" flattened:"true"`

	// Contains the delimiter you specified in the request. If you don't specify
	// a delimiter in your request, this element is absent from the response.
	Delimiter *string `type:"string"`

	// Encoding type used by Amazon S3 to encode object keys in the response.
	//
	// If you specify encoding-type request parameter, Amazon S3 includes this element
	// in the response, and returns encoded key name values in the following response
	// elements:
	//
	// Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.
	EncodingType EncodingType `type:"string" enum:"true"`

	// Indicates whether the returned list of multipart uploads is truncated. A
	// value of true indicates that the list was truncated. The list can be truncated
	// if the number of multipart uploads exceeds the limit allowed or specified
	// by max uploads.
	IsTruncated *bool `type:"boolean"`

	// The key at or after which the listing began.
	KeyMarker *string `type:"string"`

	// Maximum number of multipart uploads that could have been included in the
	// response.
	MaxUploads *int64 `type:"integer"`

	// When a list is truncated, this element specifies the value that should be
	// used for the key-marker request parameter in a subsequent request.
	NextKeyMarker *string `type:"string"`

	// When a list is truncated, this element specifies the value that should be
	// used for the upload-id-marker request parameter in a subsequent request.
	NextUploadIdMarker *string `type:"string"`

	// When a prefix is provided in the request, this field contains the specified
	// prefix. The result contains only keys starting with the specified prefix.
	Prefix *string `type:"string"`

	// Upload ID after which listing began.
	UploadIdMarker *string `type:"string"`

	// Container for elements related to a particular multipart upload. A response
	// can contain zero or more Upload elements.
	Uploads []MultipartUpload `locationName:"Upload" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (ListMultipartUploadsOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListMultipartUploadsOutput) String

String returns the string representation

type ListMultipartUploadsPaginator added in v0.9.0

type ListMultipartUploadsPaginator struct {
	aws.Pager
}

ListMultipartUploadsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListMultipartUploadsPaginator added in v0.9.0

func NewListMultipartUploadsPaginator(req ListMultipartUploadsRequest) ListMultipartUploadsPaginator

NewListMultipartUploadsRequestPaginator returns a paginator for ListMultipartUploads. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListMultipartUploadsRequest(input)
p := s3.NewListMultipartUploadsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListMultipartUploadsPaginator) CurrentPage added in v0.9.0

type ListMultipartUploadsRequest

type ListMultipartUploadsRequest struct {
	*aws.Request
	Input *ListMultipartUploadsInput
	Copy  func(*ListMultipartUploadsInput) ListMultipartUploadsRequest
}

ListMultipartUploadsRequest is the request type for the ListMultipartUploads API operation.

func (ListMultipartUploadsRequest) Send

Send marshals and sends the ListMultipartUploads API request.

type ListMultipartUploadsResponse added in v0.9.0

type ListMultipartUploadsResponse struct {
	*ListMultipartUploadsOutput
	// contains filtered or unexported fields
}

ListMultipartUploadsResponse is the response type for the ListMultipartUploads API operation.

func (*ListMultipartUploadsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListMultipartUploadsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListMultipartUploads request.

type ListObjectVersionsInput

type ListObjectVersionsInput struct {

	// The bucket name that contains the objects.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// A delimiter is a character that you specify to group keys. All keys that
	// contain the same string between the prefix and the first occurrence of the
	// delimiter are grouped under a single result element in CommonPrefixes. These
	// groups are counted as one result against the max-keys limitation. These keys
	// are not returned elsewhere in the response.
	Delimiter *string `location:"querystring" locationName:"delimiter" type:"string"`

	// Requests Amazon S3 to encode the object keys in the response and specifies
	// the encoding method to use. An object key may contain any Unicode character;
	// however, XML 1.0 parser cannot parse some characters, such as characters
	// with an ASCII value from 0 to 10. For characters that are not supported in
	// XML 1.0, you can add this parameter to request that Amazon S3 encode the
	// keys in the response.
	EncodingType EncodingType `location:"querystring" locationName:"encoding-type" type:"string" enum:"true"`

	// Specifies the key to start with when listing objects in a bucket.
	KeyMarker *string `location:"querystring" locationName:"key-marker" type:"string"`

	// Sets the maximum number of keys returned in the response. By default the
	// API returns up to 1,000 key names. The response might contain fewer keys
	// but will never contain more. If additional keys satisfy the search criteria,
	// but were not returned because max-keys was exceeded, the response contains
	// <isTruncated>true</isTruncated>. To return the additional keys, see key-marker
	// and version-id-marker.
	MaxKeys *int64 `location:"querystring" locationName:"max-keys" type:"integer"`

	// Use this parameter to select only those keys that begin with the specified
	// prefix. You can use prefixes to separate a bucket into different groupings
	// of keys. (You can think of using prefix to make groups in the same way you'd
	// use a folder in a file system.) You can use prefix with delimiter to roll
	// up numerous objects into a single result under CommonPrefixes.
	Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

	// Specifies the object version you want to start listing from.
	VersionIdMarker *string `location:"querystring" locationName:"version-id-marker" type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectVersionsInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListObjectVersionsInput) String

func (s ListObjectVersionsInput) String() string

String returns the string representation

func (*ListObjectVersionsInput) Validate

func (s *ListObjectVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectVersionsOutput

type ListObjectVersionsOutput struct {

	// All of the keys rolled up into a common prefix count as a single return when
	// calculating the number of returns.
	CommonPrefixes []CommonPrefix `type:"list" flattened:"true"`

	// Container for an object that is a delete marker.
	DeleteMarkers []DeleteMarkerEntry `locationName:"DeleteMarker" type:"list" flattened:"true"`

	// The delimiter grouping the included keys. A delimiter is a character that
	// you specify to group keys. All keys that contain the same string between
	// the prefix and the first occurrence of the delimiter are grouped under a
	// single result element in CommonPrefixes. These groups are counted as one
	// result against the max-keys limitation. These keys are not returned elsewhere
	// in the response.
	Delimiter *string `type:"string"`

	// Encoding type used by Amazon S3 to encode object key names in the XML response.
	//
	// If you specify encoding-type request parameter, Amazon S3 includes this element
	// in the response, and returns encoded key name values in the following response
	// elements:
	//
	// KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
	EncodingType EncodingType `type:"string" enum:"true"`

	// A flag that indicates whether Amazon S3 returned all of the results that
	// satisfied the search criteria. If your results were truncated, you can make
	// a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker
	// response parameters as a starting place in another request to return the
	// rest of the results.
	IsTruncated *bool `type:"boolean"`

	// Marks the last key returned in a truncated response.
	KeyMarker *string `type:"string"`

	// Specifies the maximum number of objects to return.
	MaxKeys *int64 `type:"integer"`

	// Bucket name.
	Name *string `type:"string"`

	// When the number of responses exceeds the value of MaxKeys, NextKeyMarker
	// specifies the first key not returned that satisfies the search criteria.
	// Use this value for the key-marker request parameter in a subsequent request.
	NextKeyMarker *string `type:"string"`

	// When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker
	// specifies the first object version not returned that satisfies the search
	// criteria. Use this value for the version-id-marker request parameter in a
	// subsequent request.
	NextVersionIdMarker *string `type:"string"`

	// Selects objects that start with the value supplied by this parameter.
	Prefix *string `type:"string"`

	// Marks the last version of the key returned in a truncated response.
	VersionIdMarker *string `type:"string"`

	// Container for version information.
	Versions []ObjectVersion `locationName:"Version" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (ListObjectVersionsOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListObjectVersionsOutput) String

func (s ListObjectVersionsOutput) String() string

String returns the string representation

type ListObjectVersionsPaginator added in v0.9.0

type ListObjectVersionsPaginator struct {
	aws.Pager
}

ListObjectVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListObjectVersionsPaginator added in v0.9.0

func NewListObjectVersionsPaginator(req ListObjectVersionsRequest) ListObjectVersionsPaginator

NewListObjectVersionsRequestPaginator returns a paginator for ListObjectVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListObjectVersionsRequest(input)
p := s3.NewListObjectVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListObjectVersionsPaginator) CurrentPage added in v0.9.0

type ListObjectVersionsRequest

type ListObjectVersionsRequest struct {
	*aws.Request
	Input *ListObjectVersionsInput
	Copy  func(*ListObjectVersionsInput) ListObjectVersionsRequest
}

ListObjectVersionsRequest is the request type for the ListObjectVersions API operation.

func (ListObjectVersionsRequest) Send

Send marshals and sends the ListObjectVersions API request.

type ListObjectVersionsResponse added in v0.9.0

type ListObjectVersionsResponse struct {
	*ListObjectVersionsOutput
	// contains filtered or unexported fields
}

ListObjectVersionsResponse is the response type for the ListObjectVersions API operation.

func (*ListObjectVersionsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListObjectVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListObjectVersions request.

type ListObjectsInput

type ListObjectsInput struct {

	// The name of the bucket containing the objects.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// A delimiter is a character you use to group keys.
	Delimiter *string `location:"querystring" locationName:"delimiter" type:"string"`

	// Requests Amazon S3 to encode the object keys in the response and specifies
	// the encoding method to use. An object key may contain any Unicode character;
	// however, XML 1.0 parser cannot parse some characters, such as characters
	// with an ASCII value from 0 to 10. For characters that are not supported in
	// XML 1.0, you can add this parameter to request that Amazon S3 encode the
	// keys in the response.
	EncodingType EncodingType `location:"querystring" locationName:"encoding-type" type:"string" enum:"true"`

	// Specifies the key to start with when listing objects in a bucket.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// Sets the maximum number of keys returned in the response. By default the
	// API returns up to 1,000 key names. The response might contain fewer keys
	// but will never contain more.
	MaxKeys *int64 `location:"querystring" locationName:"max-keys" type:"integer"`

	// Limits the response to keys that begin with the specified prefix.
	Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

	// Confirms that the requester knows that she or he will be charged for the
	// list objects request. Bucket owners need not specify this parameter in their
	// requests.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListObjectsInput) MarshalFields added in v0.3.0

func (s ListObjectsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListObjectsInput) String

func (s ListObjectsInput) String() string

String returns the string representation

func (*ListObjectsInput) Validate

func (s *ListObjectsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectsOutput

type ListObjectsOutput struct {

	// All of the keys rolled up in a common prefix count as a single return when
	// calculating the number of returns.
	//
	// A response can contain CommonPrefixes only if you specify a delimiter.
	//
	// CommonPrefixes contains all (if there are any) keys between Prefix and the
	// next occurrence of the string specified by the 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/. All of the keys
	// that roll up into a common prefix count as a single return when calculating
	// the number of returns.
	CommonPrefixes []CommonPrefix `type:"list" flattened:"true"`

	// Metadata about each object returned.
	Contents []Object `type:"list" flattened:"true"`

	// Causes keys that contain the same string between the prefix and the first
	// occurrence of the delimiter to be rolled up into a single result element
	// in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere
	// in the response. Each rolled-up result counts as only one return against
	// the MaxKeys value.
	Delimiter *string `type:"string"`

	// Encoding type used by Amazon S3 to encode object keys in the response.
	EncodingType EncodingType `type:"string" enum:"true"`

	// A flag that indicates whether Amazon S3 returned all of the results that
	// satisfied the search criteria.
	IsTruncated *bool `type:"boolean"`

	// Indicates where in the bucket listing begins. Marker is included in the response
	// if it was sent with the request.
	Marker *string `type:"string"`

	// The maximum number of keys returned in the response body.
	MaxKeys *int64 `type:"integer"`

	// Bucket name.
	Name *string `type:"string"`

	// When response is truncated (the IsTruncated element value in the response
	// is true), you can use the key name in this field as marker in the subsequent
	// request to get next set of objects. Amazon S3 lists objects in alphabetical
	// order Note: This element is returned only if you have delimiter request parameter
	// specified. If response does not include the NextMaker and it is truncated,
	// you can use the value of the last Key in the response as the marker in the
	// subsequent request to get the next set of object keys.
	NextMarker *string `type:"string"`

	// Keys that begin with the indicated prefix.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectsOutput) MarshalFields added in v0.3.0

func (s ListObjectsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListObjectsOutput) String

func (s ListObjectsOutput) String() string

String returns the string representation

type ListObjectsPaginator added in v0.9.0

type ListObjectsPaginator struct {
	aws.Pager
}

ListObjectsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListObjectsPaginator added in v0.9.0

func NewListObjectsPaginator(req ListObjectsRequest) ListObjectsPaginator

NewListObjectsRequestPaginator returns a paginator for ListObjects. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListObjectsRequest(input)
p := s3.NewListObjectsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListObjectsPaginator) CurrentPage added in v0.9.0

func (p *ListObjectsPaginator) CurrentPage() *ListObjectsOutput

type ListObjectsRequest

type ListObjectsRequest struct {
	*aws.Request
	Input *ListObjectsInput
	Copy  func(*ListObjectsInput) ListObjectsRequest
}

ListObjectsRequest is the request type for the ListObjects API operation.

func (ListObjectsRequest) Send

Send marshals and sends the ListObjects API request.

type ListObjectsResponse added in v0.9.0

type ListObjectsResponse struct {
	*ListObjectsOutput
	// contains filtered or unexported fields
}

ListObjectsResponse is the response type for the ListObjects API operation.

func (*ListObjectsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListObjectsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListObjects request.

type ListObjectsV2Input

type ListObjectsV2Input struct {

	// Bucket name to list.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// ContinuationToken indicates Amazon S3 that the list is being continued on
	// this bucket with a token. ContinuationToken is obfuscated and is not a real
	// key.
	ContinuationToken *string `location:"querystring" locationName:"continuation-token" type:"string"`

	// A delimiter is a character you use to group keys.
	Delimiter *string `location:"querystring" locationName:"delimiter" type:"string"`

	// Encoding type used by Amazon S3 to encode object keys in the response.
	EncodingType EncodingType `location:"querystring" locationName:"encoding-type" type:"string" enum:"true"`

	// The owner field is not present in listV2 by default, if you want to return
	// owner field with each key in the result then set the fetch owner field to
	// true.
	FetchOwner *bool `location:"querystring" locationName:"fetch-owner" type:"boolean"`

	// Sets the maximum number of keys returned in the response. By default the
	// API returns up to 1,000 key names. The response might contain fewer keys
	// but will never contain more.
	MaxKeys *int64 `location:"querystring" locationName:"max-keys" type:"integer"`

	// Limits the response to keys that begin with the specified prefix.
	Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

	// Confirms that the requester knows that she or he will be charged for the
	// list objects request in V2 style. Bucket owners need not specify this parameter
	// in their requests.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts
	// listing after this specified key. StartAfter can be any key in the bucket.
	StartAfter *string `location:"querystring" locationName:"start-after" type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectsV2Input) MarshalFields added in v0.3.0

func (s ListObjectsV2Input) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListObjectsV2Input) String

func (s ListObjectsV2Input) String() string

String returns the string representation

func (*ListObjectsV2Input) Validate

func (s *ListObjectsV2Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectsV2Output

type ListObjectsV2Output struct {

	// All of the keys rolled up into a common prefix count as a single return when
	// calculating the number of returns.
	//
	// A response can contain CommonPrefixes only if you specify a delimiter.
	//
	// CommonPrefixes contains 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/. All of the keys
	// that roll up into a common prefix count as a single return when calculating
	// the number of returns.
	CommonPrefixes []CommonPrefix `type:"list" flattened:"true"`

	// Metadata about each object returned.
	Contents []Object `type:"list" flattened:"true"`

	// If ContinuationToken was sent with the request, it is included in the response.
	ContinuationToken *string `type:"string"`

	// Causes keys that contain the same string between the prefix and the first
	// occurrence of the delimiter to be rolled up into a single result element
	// in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere
	// in the response. Each rolled-up result counts as only one return against
	// the MaxKeys value.
	Delimiter *string `type:"string"`

	// Encoding type used by Amazon S3 to encode object key names in the XML response.
	//
	// If you specify the encoding-type request parameter, Amazon S3 includes this
	// element in the response, and returns encoded key name values in the following
	// response elements:
	//
	// Delimiter, Prefix, Key, and StartAfter.
	EncodingType EncodingType `type:"string" enum:"true"`

	// Set to false if all of the results were returned. Set to true if more keys
	// are available to return. If the number of results exceeds that specified
	// by MaxKeys, all of the results might not be returned.
	IsTruncated *bool `type:"boolean"`

	// KeyCount is the number of keys returned with this request. KeyCount will
	// always be less than equals to MaxKeys field. Say you ask for 50 keys, your
	// result will include less than equals 50 keys
	KeyCount *int64 `type:"integer"`

	// Sets the maximum number of keys returned in the response. By default the
	// API returns up to 1,000 key names. The response might contain fewer keys
	// but will never contain more.
	MaxKeys *int64 `type:"integer"`

	// Bucket name.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Name *string `type:"string"`

	// NextContinuationToken is sent when isTruncated is true, which means there
	// are more keys in the bucket that can be listed. The next list requests to
	// Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken
	// is obfuscated and is not a real key
	NextContinuationToken *string `type:"string"`

	// Keys that begin with the indicated prefix.
	Prefix *string `type:"string"`

	// If StartAfter was sent with the request, it is included in the response.
	StartAfter *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectsV2Output) MarshalFields added in v0.3.0

func (s ListObjectsV2Output) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListObjectsV2Output) String

func (s ListObjectsV2Output) String() string

String returns the string representation

type ListObjectsV2Paginator added in v0.9.0

type ListObjectsV2Paginator struct {
	aws.Pager
}

ListObjectsV2Paginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListObjectsV2Paginator added in v0.9.0

func NewListObjectsV2Paginator(req ListObjectsV2Request) ListObjectsV2Paginator

NewListObjectsV2RequestPaginator returns a paginator for ListObjectsV2. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListObjectsV2Request(input)
p := s3.NewListObjectsV2RequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListObjectsV2Paginator) CurrentPage added in v0.9.0

func (p *ListObjectsV2Paginator) CurrentPage() *ListObjectsV2Output

type ListObjectsV2Request

type ListObjectsV2Request struct {
	*aws.Request
	Input *ListObjectsV2Input
	Copy  func(*ListObjectsV2Input) ListObjectsV2Request
}

ListObjectsV2Request is the request type for the ListObjectsV2 API operation.

func (ListObjectsV2Request) Send

Send marshals and sends the ListObjectsV2 API request.

type ListObjectsV2Response added in v0.9.0

type ListObjectsV2Response struct {
	*ListObjectsV2Output
	// contains filtered or unexported fields
}

ListObjectsV2Response is the response type for the ListObjectsV2 API operation.

func (*ListObjectsV2Response) SDKResponseMetdata added in v0.9.0

func (r *ListObjectsV2Response) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListObjectsV2 request.

type ListPartsInput

type ListPartsInput struct {

	// Name of the bucket to which the parts are being uploaded.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Object key for which the multipart upload was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Sets the maximum number of parts to return.
	MaxParts *int64 `location:"querystring" locationName:"max-parts" type:"integer"`

	// Specifies the part after which listing should begin. Only parts with higher
	// part numbers will be listed.
	PartNumberMarker *int64 `location:"querystring" locationName:"part-number-marker" type:"integer"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Upload ID identifying the multipart upload whose parts are being listed.
	//
	// UploadId is a required field
	UploadId *string `location:"querystring" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListPartsInput) MarshalFields added in v0.3.0

func (s ListPartsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPartsInput) String

func (s ListPartsInput) String() string

String returns the string representation

func (*ListPartsInput) Validate

func (s *ListPartsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPartsOutput

type ListPartsOutput struct {

	// If the bucket has a lifecycle rule configured with an action to abort incomplete
	// multipart uploads and the prefix in the lifecycle rule matches the object
	// name in the request, then the response includes this header indicating when
	// the initiated multipart upload will become eligible for abort operation.
	// For more information, see Aborting Incomplete Multipart Uploads Using a Bucket
	// Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
	//
	// The response will also include the x-amz-abort-rule-id header that will provide
	// the ID of the lifecycle configuration rule that defines this action.
	AbortDate *time.Time `location:"header" locationName:"x-amz-abort-date" type:"timestamp"`

	// This header is returned along with the x-amz-abort-date header. It identifies
	// applicable lifecycle configuration rule that defines the action to abort
	// incomplete multipart uploads.
	AbortRuleId *string `location:"header" locationName:"x-amz-abort-rule-id" type:"string"`

	// Name of the bucket to which the multipart upload was initiated.
	Bucket *string `type:"string"`

	// Container element that identifies who initiated the multipart upload. If
	// the initiator is an AWS account, this element provides the same information
	// as the Owner element. If the initiator is an IAM User, this element provides
	// the user ARN and display name.
	Initiator *Initiator `type:"structure"`

	// Indicates whether the returned list of parts is truncated. A true value indicates
	// that the list was truncated. A list can be truncated if the number of parts
	// exceeds the limit returned in the MaxParts element.
	IsTruncated *bool `type:"boolean"`

	// Object key for which the multipart upload was initiated.
	Key *string `min:"1" type:"string"`

	// Maximum number of parts that were allowed in the response.
	MaxParts *int64 `type:"integer"`

	// When a list is truncated, this element specifies the last part in the list,
	// as well as the value to use for the part-number-marker request parameter
	// in a subsequent request.
	NextPartNumberMarker *int64 `type:"integer"`

	// Container element that identifies the object owner, after the object is created.
	// If multipart upload is initiated by an IAM user, this element provides the
	// parent account ID and display name.
	Owner *Owner `type:"structure"`

	// When a list is truncated, this element specifies the last part in the list,
	// as well as the value to use for the part-number-marker request parameter
	// in a subsequent request.
	PartNumberMarker *int64 `type:"integer"`

	// Container for elements related to a particular part. A response can contain
	// zero or more Part elements.
	Parts []Part `locationName:"Part" type:"list" flattened:"true"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded
	// object.
	StorageClass StorageClass `type:"string" enum:"true"`

	// Upload ID identifying the multipart upload whose parts are being listed.
	UploadId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListPartsOutput) MarshalFields added in v0.3.0

func (s ListPartsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPartsOutput) String

func (s ListPartsOutput) String() string

String returns the string representation

type ListPartsPaginator added in v0.9.0

type ListPartsPaginator struct {
	aws.Pager
}

ListPartsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPartsPaginator added in v0.9.0

func NewListPartsPaginator(req ListPartsRequest) ListPartsPaginator

NewListPartsRequestPaginator returns a paginator for ListParts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListPartsRequest(input)
p := s3.NewListPartsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPartsPaginator) CurrentPage added in v0.9.0

func (p *ListPartsPaginator) CurrentPage() *ListPartsOutput

type ListPartsRequest

type ListPartsRequest struct {
	*aws.Request
	Input *ListPartsInput
	Copy  func(*ListPartsInput) ListPartsRequest
}

ListPartsRequest is the request type for the ListParts API operation.

func (ListPartsRequest) Send

Send marshals and sends the ListParts API request.

type ListPartsResponse added in v0.9.0

type ListPartsResponse struct {
	*ListPartsOutput
	// contains filtered or unexported fields
}

ListPartsResponse is the response type for the ListParts API operation.

func (*ListPartsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListPartsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListParts request.

type LoggingEnabled

type LoggingEnabled struct {

	// Specifies the bucket where you want Amazon S3 to store server access logs.
	// You can have your logs delivered to any bucket that you own, including the
	// same bucket that is being logged. You can also configure multiple buckets
	// to deliver their logs to the same target bucket. In this case, you should
	// choose a different TargetPrefix for each source bucket so that the delivered
	// log files can be distinguished by key.
	//
	// TargetBucket is a required field
	TargetBucket *string `type:"string" required:"true"`

	// Container for granting information.
	TargetGrants []TargetGrant `locationNameList:"Grant" type:"list"`

	// A prefix for all log object keys. If you store log files from multiple Amazon
	// S3 buckets in a single bucket, you can use a prefix to distinguish which
	// log files came from which bucket.
	//
	// TargetPrefix is a required field
	TargetPrefix *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 logging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the Amazon Simple Storage Service API Reference.

func (LoggingEnabled) MarshalFields added in v0.3.0

func (s LoggingEnabled) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LoggingEnabled) String

func (s LoggingEnabled) String() string

String returns the string representation

func (*LoggingEnabled) Validate

func (s *LoggingEnabled) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MFADelete

type MFADelete string
const (
	MFADeleteEnabled  MFADelete = "Enabled"
	MFADeleteDisabled MFADelete = "Disabled"
)

Enum values for MFADelete

func (MFADelete) MarshalValue added in v0.3.0

func (enum MFADelete) MarshalValue() (string, error)

func (MFADelete) MarshalValueBuf added in v0.3.0

func (enum MFADelete) MarshalValueBuf(b []byte) ([]byte, error)

type MFADeleteStatus

type MFADeleteStatus string
const (
	MFADeleteStatusEnabled  MFADeleteStatus = "Enabled"
	MFADeleteStatusDisabled MFADeleteStatus = "Disabled"
)

Enum values for MFADeleteStatus

func (MFADeleteStatus) MarshalValue added in v0.3.0

func (enum MFADeleteStatus) MarshalValue() (string, error)

func (MFADeleteStatus) MarshalValueBuf added in v0.3.0

func (enum MFADeleteStatus) MarshalValueBuf(b []byte) ([]byte, error)

type MetadataDirective

type MetadataDirective string
const (
	MetadataDirectiveCopy    MetadataDirective = "COPY"
	MetadataDirectiveReplace MetadataDirective = "REPLACE"
)

Enum values for MetadataDirective

func (MetadataDirective) MarshalValue added in v0.3.0

func (enum MetadataDirective) MarshalValue() (string, error)

func (MetadataDirective) MarshalValueBuf added in v0.3.0

func (enum MetadataDirective) MarshalValueBuf(b []byte) ([]byte, error)

type MetadataEntry added in v0.2.0

type MetadataEntry struct {

	// Name of the Object.
	Name *string `type:"string"`

	// Value of the Object.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A metadata key-value pair to store with an object.

func (MetadataEntry) MarshalFields added in v0.3.0

func (s MetadataEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MetadataEntry) String added in v0.2.0

func (s MetadataEntry) String() string

String returns the string representation

type Metrics added in v0.17.0

type Metrics struct {

	// A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold
	// event.
	//
	// EventThreshold is a required field
	EventThreshold *ReplicationTimeValue `type:"structure" required:"true"`

	// Specifies whether the replication metrics are enabled.
	//
	// Status is a required field
	Status MetricsStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified together with a ReplicationTime block.

func (Metrics) MarshalFields added in v0.17.0

func (s Metrics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Metrics) String added in v0.17.0

func (s Metrics) String() string

String returns the string representation

func (*Metrics) Validate added in v0.17.0

func (s *Metrics) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricsAndOperator

type MetricsAndOperator struct {

	// The prefix used when evaluating an AND predicate.
	Prefix *string `type:"string"`

	// The list of tags used when evaluating an AND predicate.
	Tags []Tag `locationName:"Tag" locationNameList:"Tag" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

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.

func (MetricsAndOperator) MarshalFields added in v0.3.0

func (s MetricsAndOperator) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MetricsAndOperator) String

func (s MetricsAndOperator) String() string

String returns the string representation

func (*MetricsAndOperator) Validate

func (s *MetricsAndOperator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricsConfiguration

type MetricsConfiguration struct {

	// Specifies a metrics configuration filter. The metrics configuration will
	// only include objects that meet the filter's criteria. A filter must be a
	// prefix, a tag, or a conjunction (MetricsAndOperator).
	Filter *MetricsFilter `type:"structure"`

	// The ID used to identify the metrics configuration.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 PUT Bucket metrics (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html) in the Amazon Simple Storage Service API Reference.

func (MetricsConfiguration) MarshalFields added in v0.3.0

func (s MetricsConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MetricsConfiguration) String

func (s MetricsConfiguration) String() string

String returns the string representation

func (*MetricsConfiguration) Validate

func (s *MetricsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricsFilter

type MetricsFilter struct {

	// 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.
	And *MetricsAndOperator `type:"structure"`

	// The prefix used when evaluating a metrics filter.
	Prefix *string `type:"string"`

	// The tag used when evaluating a metrics filter.
	Tag *Tag `type:"structure"`
	// contains filtered or unexported fields
}

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).

func (MetricsFilter) MarshalFields added in v0.3.0

func (s MetricsFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MetricsFilter) String

func (s MetricsFilter) String() string

String returns the string representation

func (*MetricsFilter) Validate

func (s *MetricsFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricsStatus added in v0.17.0

type MetricsStatus string
const (
	MetricsStatusEnabled  MetricsStatus = "Enabled"
	MetricsStatusDisabled MetricsStatus = "Disabled"
)

Enum values for MetricsStatus

func (MetricsStatus) MarshalValue added in v0.17.0

func (enum MetricsStatus) MarshalValue() (string, error)

func (MetricsStatus) MarshalValueBuf added in v0.17.0

func (enum MetricsStatus) MarshalValueBuf(b []byte) ([]byte, error)

type MultipartUpload

type MultipartUpload struct {

	// Date and time at which the multipart upload was initiated.
	Initiated *time.Time `type:"timestamp"`

	// Identifies who initiated the multipart upload.
	Initiator *Initiator `type:"structure"`

	// Key of the object for which the multipart upload was initiated.
	Key *string `min:"1" type:"string"`

	// Specifies the owner of the object that is part of the multipart upload.
	Owner *Owner `type:"structure"`

	// The class of storage used to store the object.
	StorageClass StorageClass `type:"string" enum:"true"`

	// Upload ID that identifies the multipart upload.
	UploadId *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the MultipartUpload for the Amazon S3 object.

func (MultipartUpload) MarshalFields added in v0.3.0

func (s MultipartUpload) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MultipartUpload) String

func (s MultipartUpload) String() string

String returns the string representation

type NoncurrentVersionExpiration

type NoncurrentVersionExpiration struct {

	// Specifies the number of days an object is noncurrent before Amazon S3 can
	// perform the associated action. For information about the noncurrent days
	// calculations, see How Amazon S3 Calculates When an Object Became Noncurrent
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations)
	// in the Amazon Simple Storage Service Developer Guide.
	NoncurrentDays *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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.

func (NoncurrentVersionExpiration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NoncurrentVersionExpiration) String

String returns the string representation

type NoncurrentVersionTransition

type NoncurrentVersionTransition struct {

	// Specifies the number of days an object is noncurrent before Amazon S3 can
	// perform the associated action. For information about the noncurrent days
	// calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations)
	// in the Amazon Simple Storage Service Developer Guide.
	NoncurrentDays *int64 `type:"integer"`

	// The class of storage used to store the object.
	StorageClass TransitionStorageClass `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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. 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, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

func (NoncurrentVersionTransition) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NoncurrentVersionTransition) String

String returns the string representation

type NotificationConfiguration added in v0.9.0

type NotificationConfiguration struct {

	// Describes the AWS Lambda functions to invoke and the events for which to
	// invoke them.
	LambdaFunctionConfigurations []LambdaFunctionConfiguration `locationName:"CloudFunctionConfiguration" type:"list" flattened:"true"`

	// The Amazon Simple Queue Service queues to publish messages to and the events
	// for which to publish messages.
	QueueConfigurations []QueueConfiguration `locationName:"QueueConfiguration" type:"list" flattened:"true"`

	// The topic to which notifications are sent and the events for which notifications
	// are generated.
	TopicConfigurations []TopicConfiguration `locationName:"TopicConfiguration" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

func (NotificationConfiguration) MarshalFields added in v0.9.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NotificationConfiguration) String added in v0.9.0

func (s NotificationConfiguration) String() string

String returns the string representation

func (*NotificationConfiguration) Validate added in v0.9.0

func (s *NotificationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NotificationConfigurationDeprecated added in v0.9.0

type NotificationConfigurationDeprecated struct {

	// Container for specifying the AWS Lambda notification configuration.
	CloudFunctionConfiguration *CloudFunctionConfiguration `type:"structure"`

	// This data type is deprecated. This data type specifies the configuration
	// for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue
	// when Amazon S3 detects specified events.
	QueueConfiguration *QueueConfigurationDeprecated `type:"structure"`

	// This data type is deprecated. 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.
	TopicConfiguration *TopicConfigurationDeprecated `type:"structure"`
	// contains filtered or unexported fields
}

func (NotificationConfigurationDeprecated) MarshalFields added in v0.9.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NotificationConfigurationDeprecated) String added in v0.9.0

String returns the string representation

type NotificationConfigurationFilter

type NotificationConfigurationFilter struct {

	// A container for object key name prefix and suffix filtering rules.
	Key *S3KeyFilter `locationName:"S3Key" type:"structure"`
	// contains filtered or unexported fields
}

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the Amazon Simple Storage Service Developer Guide.

func (NotificationConfigurationFilter) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NotificationConfigurationFilter) String

String returns the string representation

type Object

type Object struct {

	// The entity tag is an MD5 hash of the object. ETag reflects only changes to
	// the contents of an object, not its metadata.
	ETag *string `type:"string"`

	// The name that you assign to an object. You use the object key to retrieve
	// the object.
	Key *string `min:"1" type:"string"`

	// The date the Object was Last Modified
	LastModified *time.Time `type:"timestamp"`

	// The owner of the object
	Owner *Owner `type:"structure"`

	// Size in bytes of the object
	Size *int64 `type:"integer"`

	// The class of storage used to store the object.
	StorageClass ObjectStorageClass `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An object consists of data and its descriptive metadata.

func (Object) MarshalFields added in v0.3.0

func (s Object) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Object) String

func (s Object) String() string

String returns the string representation

type ObjectCannedACL

type ObjectCannedACL string
const (
	ObjectCannedACLPrivate                ObjectCannedACL = "private"
	ObjectCannedACLPublicRead             ObjectCannedACL = "public-read"
	ObjectCannedACLPublicReadWrite        ObjectCannedACL = "public-read-write"
	ObjectCannedACLAuthenticatedRead      ObjectCannedACL = "authenticated-read"
	ObjectCannedACLAwsExecRead            ObjectCannedACL = "aws-exec-read"
	ObjectCannedACLBucketOwnerRead        ObjectCannedACL = "bucket-owner-read"
	ObjectCannedACLBucketOwnerFullControl ObjectCannedACL = "bucket-owner-full-control"
)

Enum values for ObjectCannedACL

func (ObjectCannedACL) MarshalValue added in v0.3.0

func (enum ObjectCannedACL) MarshalValue() (string, error)

func (ObjectCannedACL) MarshalValueBuf added in v0.3.0

func (enum ObjectCannedACL) MarshalValueBuf(b []byte) ([]byte, error)

type ObjectIdentifier

type ObjectIdentifier struct {

	// Key name of the object to delete.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// VersionId for the specific version of the object to delete.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Object Identifier is unique value to identify objects.

func (ObjectIdentifier) MarshalFields added in v0.3.0

func (s ObjectIdentifier) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ObjectIdentifier) String

func (s ObjectIdentifier) String() string

String returns the string representation

func (*ObjectIdentifier) Validate

func (s *ObjectIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ObjectLockConfiguration added in v0.6.0

type ObjectLockConfiguration struct {

	// Indicates whether this bucket has an Object Lock configuration enabled.
	ObjectLockEnabled ObjectLockEnabled `type:"string" enum:"true"`

	// The Object Lock rule in place for the specified object.
	Rule *ObjectLockRule `type:"structure"`
	// contains filtered or unexported fields
}

The container element for Object Lock configuration parameters.

func (ObjectLockConfiguration) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ObjectLockConfiguration) String added in v0.6.0

func (s ObjectLockConfiguration) String() string

String returns the string representation

type ObjectLockEnabled added in v0.6.0

type ObjectLockEnabled string
const (
	ObjectLockEnabledEnabled ObjectLockEnabled = "Enabled"
)

Enum values for ObjectLockEnabled

func (ObjectLockEnabled) MarshalValue added in v0.6.0

func (enum ObjectLockEnabled) MarshalValue() (string, error)

func (ObjectLockEnabled) MarshalValueBuf added in v0.6.0

func (enum ObjectLockEnabled) MarshalValueBuf(b []byte) ([]byte, error)

type ObjectLockLegalHold added in v0.6.0

type ObjectLockLegalHold struct {

	// Indicates whether the specified object has a Legal Hold in place.
	Status ObjectLockLegalHoldStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A Legal Hold configuration for an object.

func (ObjectLockLegalHold) MarshalFields added in v0.6.0

func (s ObjectLockLegalHold) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ObjectLockLegalHold) String added in v0.6.0

func (s ObjectLockLegalHold) String() string

String returns the string representation

type ObjectLockLegalHoldStatus added in v0.6.0

type ObjectLockLegalHoldStatus string
const (
	ObjectLockLegalHoldStatusOn  ObjectLockLegalHoldStatus = "ON"
	ObjectLockLegalHoldStatusOff ObjectLockLegalHoldStatus = "OFF"
)

Enum values for ObjectLockLegalHoldStatus

func (ObjectLockLegalHoldStatus) MarshalValue added in v0.6.0

func (enum ObjectLockLegalHoldStatus) MarshalValue() (string, error)

func (ObjectLockLegalHoldStatus) MarshalValueBuf added in v0.6.0

func (enum ObjectLockLegalHoldStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ObjectLockMode added in v0.6.0

type ObjectLockMode string
const (
	ObjectLockModeGovernance ObjectLockMode = "GOVERNANCE"
	ObjectLockModeCompliance ObjectLockMode = "COMPLIANCE"
)

Enum values for ObjectLockMode

func (ObjectLockMode) MarshalValue added in v0.6.0

func (enum ObjectLockMode) MarshalValue() (string, error)

func (ObjectLockMode) MarshalValueBuf added in v0.6.0

func (enum ObjectLockMode) MarshalValueBuf(b []byte) ([]byte, error)

type ObjectLockRetention added in v0.6.0

type ObjectLockRetention struct {

	// Indicates the Retention mode for the specified object.
	Mode ObjectLockRetentionMode `type:"string" enum:"true"`

	// The date on which this Object Lock Retention will expire.
	RetainUntilDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

A Retention configuration for an object.

func (ObjectLockRetention) MarshalFields added in v0.6.0

func (s ObjectLockRetention) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ObjectLockRetention) String added in v0.6.0

func (s ObjectLockRetention) String() string

String returns the string representation

type ObjectLockRetentionMode added in v0.6.0

type ObjectLockRetentionMode string
const (
	ObjectLockRetentionModeGovernance ObjectLockRetentionMode = "GOVERNANCE"
	ObjectLockRetentionModeCompliance ObjectLockRetentionMode = "COMPLIANCE"
)

Enum values for ObjectLockRetentionMode

func (ObjectLockRetentionMode) MarshalValue added in v0.6.0

func (enum ObjectLockRetentionMode) MarshalValue() (string, error)

func (ObjectLockRetentionMode) MarshalValueBuf added in v0.6.0

func (enum ObjectLockRetentionMode) MarshalValueBuf(b []byte) ([]byte, error)

type ObjectLockRule added in v0.6.0

type ObjectLockRule struct {

	// The default retention period that you want to apply to new objects placed
	// in the specified bucket.
	DefaultRetention *DefaultRetention `type:"structure"`
	// contains filtered or unexported fields
}

The container element for an Object Lock rule.

func (ObjectLockRule) MarshalFields added in v0.6.0

func (s ObjectLockRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ObjectLockRule) String added in v0.6.0

func (s ObjectLockRule) String() string

String returns the string representation

type ObjectStorageClass

type ObjectStorageClass string
const (
	ObjectStorageClassStandard           ObjectStorageClass = "STANDARD"
	ObjectStorageClassReducedRedundancy  ObjectStorageClass = "REDUCED_REDUNDANCY"
	ObjectStorageClassGlacier            ObjectStorageClass = "GLACIER"
	ObjectStorageClassStandardIa         ObjectStorageClass = "STANDARD_IA"
	ObjectStorageClassOnezoneIa          ObjectStorageClass = "ONEZONE_IA"
	ObjectStorageClassIntelligentTiering ObjectStorageClass = "INTELLIGENT_TIERING"
	ObjectStorageClassDeepArchive        ObjectStorageClass = "DEEP_ARCHIVE"
)

Enum values for ObjectStorageClass

func (ObjectStorageClass) MarshalValue added in v0.3.0

func (enum ObjectStorageClass) MarshalValue() (string, error)

func (ObjectStorageClass) MarshalValueBuf added in v0.3.0

func (enum ObjectStorageClass) MarshalValueBuf(b []byte) ([]byte, error)

type ObjectVersion

type ObjectVersion struct {

	// The entity tag is an MD5 hash of that version of the object.
	ETag *string `type:"string"`

	// Specifies whether the object is (true) or is not (false) the latest version
	// of an object.
	IsLatest *bool `type:"boolean"`

	// The object key.
	Key *string `min:"1" type:"string"`

	// Date and time the object was last modified.
	LastModified *time.Time `type:"timestamp"`

	// Specifies the owner of the object.
	Owner *Owner `type:"structure"`

	// Size in bytes of the object.
	Size *int64 `type:"integer"`

	// The class of storage used to store the object.
	StorageClass ObjectVersionStorageClass `type:"string" enum:"true"`

	// Version ID of an object.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

The version of an object.

func (ObjectVersion) MarshalFields added in v0.3.0

func (s ObjectVersion) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ObjectVersion) String

func (s ObjectVersion) String() string

String returns the string representation

type ObjectVersionStorageClass

type ObjectVersionStorageClass string
const (
	ObjectVersionStorageClassStandard ObjectVersionStorageClass = "STANDARD"
)

Enum values for ObjectVersionStorageClass

func (ObjectVersionStorageClass) MarshalValue added in v0.3.0

func (enum ObjectVersionStorageClass) MarshalValue() (string, error)

func (ObjectVersionStorageClass) MarshalValueBuf added in v0.3.0

func (enum ObjectVersionStorageClass) MarshalValueBuf(b []byte) ([]byte, error)

type OutputLocation added in v0.2.0

type OutputLocation struct {

	// Describes an S3 location that will receive the results of the restore request.
	S3 *S3Location `type:"structure"`
	// contains filtered or unexported fields
}

Describes the location where the restore job's output is stored.

func (OutputLocation) MarshalFields added in v0.3.0

func (s OutputLocation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OutputLocation) String added in v0.2.0

func (s OutputLocation) String() string

String returns the string representation

func (*OutputLocation) Validate added in v0.2.0

func (s *OutputLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OutputSerialization added in v0.2.0

type OutputSerialization struct {

	// Describes the serialization of CSV-encoded Select results.
	CSV *CSVOutput `type:"structure"`

	// Specifies JSON as request's output serialization format.
	JSON *JSONOutput `type:"structure"`
	// contains filtered or unexported fields
}

Describes how results of the Select job are serialized.

func (OutputSerialization) MarshalFields added in v0.3.0

func (s OutputSerialization) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OutputSerialization) String added in v0.2.0

func (s OutputSerialization) String() string

String returns the string representation

type Owner

type Owner struct {

	// Container for the display name of the owner.
	DisplayName *string `type:"string"`

	// Container for the ID of the owner.
	ID *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the owner's display name and ID.

func (Owner) MarshalFields added in v0.3.0

func (s Owner) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Owner) String

func (s Owner) String() string

String returns the string representation

type OwnerOverride added in v0.2.0

type OwnerOverride string
const (
	OwnerOverrideDestination OwnerOverride = "Destination"
)

Enum values for OwnerOverride

func (OwnerOverride) MarshalValue added in v0.3.0

func (enum OwnerOverride) MarshalValue() (string, error)

func (OwnerOverride) MarshalValueBuf added in v0.3.0

func (enum OwnerOverride) MarshalValueBuf(b []byte) ([]byte, error)

type ParquetInput added in v0.5.0

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

Container for Parquet.

func (ParquetInput) MarshalFields added in v0.5.0

func (s ParquetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ParquetInput) String added in v0.5.0

func (s ParquetInput) String() string

String returns the string representation

type Part

type Part struct {

	// Entity tag returned when the part was uploaded.
	ETag *string `type:"string"`

	// Date and time at which the part was uploaded.
	LastModified *time.Time `type:"timestamp"`

	// Part number identifying the part. This is a positive integer between 1 and
	// 10,000.
	PartNumber *int64 `type:"integer"`

	// Size in bytes of the uploaded part data.
	Size *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Container for elements related to a part.

func (Part) MarshalFields added in v0.3.0

func (s Part) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Part) String

func (s Part) String() string

String returns the string representation

type Payer

type Payer string
const (
	PayerRequester   Payer = "Requester"
	PayerBucketOwner Payer = "BucketOwner"
)

Enum values for Payer

func (Payer) MarshalValue added in v0.3.0

func (enum Payer) MarshalValue() (string, error)

func (Payer) MarshalValueBuf added in v0.3.0

func (enum Payer) MarshalValueBuf(b []byte) ([]byte, error)

type Permission

type Permission string
const (
	PermissionFullControl Permission = "FULL_CONTROL"
	PermissionWrite       Permission = "WRITE"
	PermissionWriteAcp    Permission = "WRITE_ACP"
	PermissionRead        Permission = "READ"
	PermissionReadAcp     Permission = "READ_ACP"
)

Enum values for Permission

func (Permission) MarshalValue added in v0.3.0

func (enum Permission) MarshalValue() (string, error)

func (Permission) MarshalValueBuf added in v0.3.0

func (enum Permission) MarshalValueBuf(b []byte) ([]byte, error)

type PolicyStatus added in v0.6.0

type PolicyStatus struct {

	// The policy status for this bucket. TRUE indicates that this bucket is public.
	// FALSE indicates that the bucket is not public.
	IsPublic *bool `locationName:"IsPublic" type:"boolean"`
	// contains filtered or unexported fields
}

The container element for a bucket's policy status.

func (PolicyStatus) MarshalFields added in v0.6.0

func (s PolicyStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PolicyStatus) String added in v0.6.0

func (s PolicyStatus) String() string

String returns the string representation

type Protocol

type Protocol string
const (
	ProtocolHttp  Protocol = "http"
	ProtocolHttps Protocol = "https"
)

Enum values for Protocol

func (Protocol) MarshalValue added in v0.3.0

func (enum Protocol) MarshalValue() (string, error)

func (Protocol) MarshalValueBuf added in v0.3.0

func (enum Protocol) MarshalValueBuf(b []byte) ([]byte, error)

type PublicAccessBlockConfiguration added in v0.6.0

type PublicAccessBlockConfiguration struct {

	// Specifies whether Amazon S3 should block public access control lists (ACLs)
	// for this bucket and objects in this bucket. Setting this element to TRUE
	// causes the following behavior:
	//
	//    * PUT Bucket acl and PUT Object acl calls fail if the specified ACL is
	//    public.
	//
	//    * PUT Object calls fail if the request includes a public ACL.
	//
	//    * PUT Bucket calls fail if the request includes a public ACL.
	//
	// Enabling this setting doesn't affect existing policies or ACLs.
	BlockPublicAcls *bool `locationName:"BlockPublicAcls" type:"boolean"`

	// Specifies whether Amazon S3 should block public bucket policies for this
	// bucket. Setting this element to TRUE causes Amazon S3 to reject calls to
	// PUT Bucket policy if the specified bucket policy allows public access.
	//
	// Enabling this setting doesn't affect existing bucket policies.
	BlockPublicPolicy *bool `locationName:"BlockPublicPolicy" type:"boolean"`

	// Specifies whether Amazon S3 should ignore public ACLs for this bucket and
	// objects in this bucket. Setting this element to TRUE causes Amazon S3 to
	// ignore all public ACLs on this bucket and objects in this bucket.
	//
	// Enabling this setting doesn't affect the persistence of any existing ACLs
	// and doesn't prevent new public ACLs from being set.
	IgnorePublicAcls *bool `locationName:"IgnorePublicAcls" type:"boolean"`

	// Specifies whether Amazon S3 should restrict public bucket policies for this
	// bucket. Setting this element to TRUE restricts access to this bucket to only
	// AWS services and authorized users within this account if the bucket has a
	// public policy.
	//
	// Enabling this setting doesn't affect previously stored bucket policies, except
	// that public and cross-account access within any public bucket policy, including
	// non-public delegation to specific accounts, is blocked.
	RestrictPublicBuckets *bool `locationName:"RestrictPublicBuckets" type:"boolean"`
	// contains filtered or unexported fields
}

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" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the Amazon Simple Storage Service Developer Guide.

func (PublicAccessBlockConfiguration) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PublicAccessBlockConfiguration) String added in v0.6.0

String returns the string representation

type PutBucketAccelerateConfigurationInput

type PutBucketAccelerateConfigurationInput struct {

	// Container for setting the transfer acceleration state.
	//
	// AccelerateConfiguration is a required field
	AccelerateConfiguration *AccelerateConfiguration `locationName:"AccelerateConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// Name of the bucket for which the accelerate configuration is set.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBucketAccelerateConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketAccelerateConfigurationInput) String

String returns the string representation

func (*PutBucketAccelerateConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBucketAccelerateConfigurationOutput

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

func (PutBucketAccelerateConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketAccelerateConfigurationOutput) String

String returns the string representation

type PutBucketAccelerateConfigurationRequest

type PutBucketAccelerateConfigurationRequest struct {
	*aws.Request
	Input *PutBucketAccelerateConfigurationInput
	Copy  func(*PutBucketAccelerateConfigurationInput) PutBucketAccelerateConfigurationRequest
}

PutBucketAccelerateConfigurationRequest is the request type for the PutBucketAccelerateConfiguration API operation.

func (PutBucketAccelerateConfigurationRequest) Send

Send marshals and sends the PutBucketAccelerateConfiguration API request.

type PutBucketAccelerateConfigurationResponse added in v0.9.0

type PutBucketAccelerateConfigurationResponse struct {
	*PutBucketAccelerateConfigurationOutput
	// contains filtered or unexported fields
}

PutBucketAccelerateConfigurationResponse is the response type for the PutBucketAccelerateConfiguration API operation.

func (*PutBucketAccelerateConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketAccelerateConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketAccelerateConfiguration request.

type PutBucketAclInput

type PutBucketAclInput struct {

	// The canned ACL to apply to the bucket.
	ACL BucketCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`

	// Contains the elements that set the ACL permissions for an object per grantee.
	AccessControlPolicy *AccessControlPolicy `locationName:"AccessControlPolicy" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// The bucket to which to apply the ACL.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Allows grantee the read, write, read ACP, and write ACP permissions on the
	// bucket.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to list the objects in the bucket.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the bucket ACL.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to create, overwrite, and delete any object in the bucket.
	GrantWrite *string `location:"header" locationName:"x-amz-grant-write" type:"string"`

	// Allows grantee to write the ACL for the applicable bucket.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`
	// contains filtered or unexported fields
}

func (PutBucketAclInput) MarshalFields added in v0.3.0

func (s PutBucketAclInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketAclInput) String

func (s PutBucketAclInput) String() string

String returns the string representation

func (*PutBucketAclInput) Validate

func (s *PutBucketAclInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketAclOutput

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

func (PutBucketAclOutput) MarshalFields added in v0.3.0

func (s PutBucketAclOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketAclOutput) String

func (s PutBucketAclOutput) String() string

String returns the string representation

type PutBucketAclRequest

type PutBucketAclRequest struct {
	*aws.Request
	Input *PutBucketAclInput
	Copy  func(*PutBucketAclInput) PutBucketAclRequest
}

PutBucketAclRequest is the request type for the PutBucketAcl API operation.

func (PutBucketAclRequest) Send

Send marshals and sends the PutBucketAcl API request.

type PutBucketAclResponse added in v0.9.0

type PutBucketAclResponse struct {
	*PutBucketAclOutput
	// contains filtered or unexported fields
}

PutBucketAclResponse is the response type for the PutBucketAcl API operation.

func (*PutBucketAclResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketAclResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketAcl request.

type PutBucketAnalyticsConfigurationInput

type PutBucketAnalyticsConfigurationInput struct {

	// The configuration and any analyses for the analytics filter.
	//
	// AnalyticsConfiguration is a required field
	AnalyticsConfiguration *AnalyticsConfiguration `locationName:"AnalyticsConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// The name of the bucket to which an analytics configuration is stored.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID that identifies the analytics configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBucketAnalyticsConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketAnalyticsConfigurationInput) String

String returns the string representation

func (*PutBucketAnalyticsConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBucketAnalyticsConfigurationOutput

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

func (PutBucketAnalyticsConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketAnalyticsConfigurationOutput) String

String returns the string representation

type PutBucketAnalyticsConfigurationRequest

type PutBucketAnalyticsConfigurationRequest struct {
	*aws.Request
	Input *PutBucketAnalyticsConfigurationInput
	Copy  func(*PutBucketAnalyticsConfigurationInput) PutBucketAnalyticsConfigurationRequest
}

PutBucketAnalyticsConfigurationRequest is the request type for the PutBucketAnalyticsConfiguration API operation.

func (PutBucketAnalyticsConfigurationRequest) Send

Send marshals and sends the PutBucketAnalyticsConfiguration API request.

type PutBucketAnalyticsConfigurationResponse added in v0.9.0

type PutBucketAnalyticsConfigurationResponse struct {
	*PutBucketAnalyticsConfigurationOutput
	// contains filtered or unexported fields
}

PutBucketAnalyticsConfigurationResponse is the response type for the PutBucketAnalyticsConfiguration API operation.

func (*PutBucketAnalyticsConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketAnalyticsConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketAnalyticsConfiguration request.

type PutBucketCorsInput

type PutBucketCorsInput struct {

	// Specifies the bucket impacted by the corsconfiguration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Describes the cross-origin access configuration for objects in an Amazon
	// S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon
	// Simple Storage Service Developer Guide.
	//
	// CORSConfiguration is a required field
	CORSConfiguration *CORSConfiguration `locationName:"CORSConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketCorsInput) MarshalFields added in v0.3.0

func (s PutBucketCorsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketCorsInput) String

func (s PutBucketCorsInput) String() string

String returns the string representation

func (*PutBucketCorsInput) Validate

func (s *PutBucketCorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketCorsOutput

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

func (PutBucketCorsOutput) MarshalFields added in v0.3.0

func (s PutBucketCorsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketCorsOutput) String

func (s PutBucketCorsOutput) String() string

String returns the string representation

type PutBucketCorsRequest

type PutBucketCorsRequest struct {
	*aws.Request
	Input *PutBucketCorsInput
	Copy  func(*PutBucketCorsInput) PutBucketCorsRequest
}

PutBucketCorsRequest is the request type for the PutBucketCors API operation.

func (PutBucketCorsRequest) Send

Send marshals and sends the PutBucketCors API request.

type PutBucketCorsResponse added in v0.9.0

type PutBucketCorsResponse struct {
	*PutBucketCorsOutput
	// contains filtered or unexported fields
}

PutBucketCorsResponse is the response type for the PutBucketCors API operation.

func (*PutBucketCorsResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketCorsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketCors request.

type PutBucketEncryptionInput added in v0.2.0

type PutBucketEncryptionInput struct {

	// Specifies default encryption for a bucket using server-side encryption with
	// Amazon S3-managed keys (SSE-S3) or customer master keys stored in AWS KMS
	// (SSE-KMS). For information about the Amazon S3 default encryption feature,
	// see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Specifies the default server-side-encryption configuration.
	//
	// ServerSideEncryptionConfiguration is a required field
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (PutBucketEncryptionInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketEncryptionInput) String added in v0.2.0

func (s PutBucketEncryptionInput) String() string

String returns the string representation

func (*PutBucketEncryptionInput) Validate added in v0.2.0

func (s *PutBucketEncryptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketEncryptionOutput added in v0.2.0

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

func (PutBucketEncryptionOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketEncryptionOutput) String added in v0.2.0

func (s PutBucketEncryptionOutput) String() string

String returns the string representation

type PutBucketEncryptionRequest added in v0.2.0

type PutBucketEncryptionRequest struct {
	*aws.Request
	Input *PutBucketEncryptionInput
	Copy  func(*PutBucketEncryptionInput) PutBucketEncryptionRequest
}

PutBucketEncryptionRequest is the request type for the PutBucketEncryption API operation.

func (PutBucketEncryptionRequest) Send added in v0.2.0

Send marshals and sends the PutBucketEncryption API request.

type PutBucketEncryptionResponse added in v0.9.0

type PutBucketEncryptionResponse struct {
	*PutBucketEncryptionOutput
	// contains filtered or unexported fields
}

PutBucketEncryptionResponse is the response type for the PutBucketEncryption API operation.

func (*PutBucketEncryptionResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketEncryptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketEncryption request.

type PutBucketInventoryConfigurationInput

type PutBucketInventoryConfigurationInput struct {

	// The name of the bucket where the inventory configuration will be stored.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID used to identify the inventory configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`

	// Specifies the inventory configuration.
	//
	// InventoryConfiguration is a required field
	InventoryConfiguration *InventoryConfiguration `locationName:"InventoryConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketInventoryConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketInventoryConfigurationInput) String

String returns the string representation

func (*PutBucketInventoryConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBucketInventoryConfigurationOutput

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

func (PutBucketInventoryConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketInventoryConfigurationOutput) String

String returns the string representation

type PutBucketInventoryConfigurationRequest

type PutBucketInventoryConfigurationRequest struct {
	*aws.Request
	Input *PutBucketInventoryConfigurationInput
	Copy  func(*PutBucketInventoryConfigurationInput) PutBucketInventoryConfigurationRequest
}

PutBucketInventoryConfigurationRequest is the request type for the PutBucketInventoryConfiguration API operation.

func (PutBucketInventoryConfigurationRequest) Send

Send marshals and sends the PutBucketInventoryConfiguration API request.

type PutBucketInventoryConfigurationResponse added in v0.9.0

type PutBucketInventoryConfigurationResponse struct {
	*PutBucketInventoryConfigurationOutput
	// contains filtered or unexported fields
}

PutBucketInventoryConfigurationResponse is the response type for the PutBucketInventoryConfiguration API operation.

func (*PutBucketInventoryConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketInventoryConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketInventoryConfiguration request.

type PutBucketLifecycleConfigurationInput

type PutBucketLifecycleConfigurationInput struct {

	// The name of the bucket for which to set the configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Container for lifecycle rules. You can add as many as 1,000 rules.
	LifecycleConfiguration *BucketLifecycleConfiguration `locationName:"LifecycleConfiguration" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketLifecycleConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketLifecycleConfigurationInput) String

String returns the string representation

func (*PutBucketLifecycleConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBucketLifecycleConfigurationOutput

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

func (PutBucketLifecycleConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketLifecycleConfigurationOutput) String

String returns the string representation

type PutBucketLifecycleConfigurationRequest

type PutBucketLifecycleConfigurationRequest struct {
	*aws.Request
	Input *PutBucketLifecycleConfigurationInput
	Copy  func(*PutBucketLifecycleConfigurationInput) PutBucketLifecycleConfigurationRequest
}

PutBucketLifecycleConfigurationRequest is the request type for the PutBucketLifecycleConfiguration API operation.

func (PutBucketLifecycleConfigurationRequest) Send

Send marshals and sends the PutBucketLifecycleConfiguration API request.

type PutBucketLifecycleConfigurationResponse added in v0.9.0

type PutBucketLifecycleConfigurationResponse struct {
	*PutBucketLifecycleConfigurationOutput
	// contains filtered or unexported fields
}

PutBucketLifecycleConfigurationResponse is the response type for the PutBucketLifecycleConfiguration API operation.

func (*PutBucketLifecycleConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketLifecycleConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketLifecycleConfiguration request.

type PutBucketLifecycleInput

type PutBucketLifecycleInput struct {

	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Container for lifecycle rules. You can add as many as 1000 rules.
	LifecycleConfiguration *LifecycleConfiguration `locationName:"LifecycleConfiguration" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketLifecycleInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketLifecycleInput) String

func (s PutBucketLifecycleInput) String() string

String returns the string representation

func (*PutBucketLifecycleInput) Validate

func (s *PutBucketLifecycleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketLifecycleOutput

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

func (PutBucketLifecycleOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketLifecycleOutput) String

func (s PutBucketLifecycleOutput) String() string

String returns the string representation

type PutBucketLifecycleRequest

type PutBucketLifecycleRequest struct {
	*aws.Request
	Input *PutBucketLifecycleInput
	Copy  func(*PutBucketLifecycleInput) PutBucketLifecycleRequest
}

PutBucketLifecycleRequest is the request type for the PutBucketLifecycle API operation.

func (PutBucketLifecycleRequest) Send

Send marshals and sends the PutBucketLifecycle API request.

type PutBucketLifecycleResponse added in v0.9.0

type PutBucketLifecycleResponse struct {
	*PutBucketLifecycleOutput
	// contains filtered or unexported fields
}

PutBucketLifecycleResponse is the response type for the PutBucketLifecycle API operation.

func (*PutBucketLifecycleResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketLifecycleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketLifecycle request.

type PutBucketLoggingInput

type PutBucketLoggingInput struct {

	// The name of the bucket for which to set the logging parameters.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Container for logging status information.
	//
	// BucketLoggingStatus is a required field
	BucketLoggingStatus *BucketLoggingStatus `locationName:"BucketLoggingStatus" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketLoggingInput) MarshalFields added in v0.3.0

func (s PutBucketLoggingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketLoggingInput) String

func (s PutBucketLoggingInput) String() string

String returns the string representation

func (*PutBucketLoggingInput) Validate

func (s *PutBucketLoggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketLoggingOutput

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

func (PutBucketLoggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketLoggingOutput) String

func (s PutBucketLoggingOutput) String() string

String returns the string representation

type PutBucketLoggingRequest

type PutBucketLoggingRequest struct {
	*aws.Request
	Input *PutBucketLoggingInput
	Copy  func(*PutBucketLoggingInput) PutBucketLoggingRequest
}

PutBucketLoggingRequest is the request type for the PutBucketLogging API operation.

func (PutBucketLoggingRequest) Send

Send marshals and sends the PutBucketLogging API request.

type PutBucketLoggingResponse added in v0.9.0

type PutBucketLoggingResponse struct {
	*PutBucketLoggingOutput
	// contains filtered or unexported fields
}

PutBucketLoggingResponse is the response type for the PutBucketLogging API operation.

func (*PutBucketLoggingResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketLoggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketLogging request.

type PutBucketMetricsConfigurationInput

type PutBucketMetricsConfigurationInput struct {

	// The name of the bucket for which the metrics configuration is set.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The ID used to identify the metrics configuration.
	//
	// Id is a required field
	Id *string `location:"querystring" locationName:"id" type:"string" required:"true"`

	// Specifies the metrics configuration.
	//
	// MetricsConfiguration is a required field
	MetricsConfiguration *MetricsConfiguration `locationName:"MetricsConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketMetricsConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketMetricsConfigurationInput) String

String returns the string representation

func (*PutBucketMetricsConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBucketMetricsConfigurationOutput

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

func (PutBucketMetricsConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketMetricsConfigurationOutput) String

String returns the string representation

type PutBucketMetricsConfigurationRequest

type PutBucketMetricsConfigurationRequest struct {
	*aws.Request
	Input *PutBucketMetricsConfigurationInput
	Copy  func(*PutBucketMetricsConfigurationInput) PutBucketMetricsConfigurationRequest
}

PutBucketMetricsConfigurationRequest is the request type for the PutBucketMetricsConfiguration API operation.

func (PutBucketMetricsConfigurationRequest) Send

Send marshals and sends the PutBucketMetricsConfiguration API request.

type PutBucketMetricsConfigurationResponse added in v0.9.0

type PutBucketMetricsConfigurationResponse struct {
	*PutBucketMetricsConfigurationOutput
	// contains filtered or unexported fields
}

PutBucketMetricsConfigurationResponse is the response type for the PutBucketMetricsConfiguration API operation.

func (*PutBucketMetricsConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketMetricsConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketMetricsConfiguration request.

type PutBucketNotificationConfigurationInput

type PutBucketNotificationConfigurationInput struct {

	// The name of the bucket.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// A container for specifying the notification configuration of the bucket.
	// If this element is empty, notifications are turned off for the bucket.
	//
	// NotificationConfiguration is a required field
	NotificationConfiguration *NotificationConfiguration `locationName:"NotificationConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketNotificationConfigurationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketNotificationConfigurationInput) String

String returns the string representation

func (*PutBucketNotificationConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBucketNotificationConfigurationOutput

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

func (PutBucketNotificationConfigurationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketNotificationConfigurationOutput) String

String returns the string representation

type PutBucketNotificationConfigurationRequest

PutBucketNotificationConfigurationRequest is the request type for the PutBucketNotificationConfiguration API operation.

func (PutBucketNotificationConfigurationRequest) Send

Send marshals and sends the PutBucketNotificationConfiguration API request.

type PutBucketNotificationConfigurationResponse added in v0.9.0

type PutBucketNotificationConfigurationResponse struct {
	*PutBucketNotificationConfigurationOutput
	// contains filtered or unexported fields
}

PutBucketNotificationConfigurationResponse is the response type for the PutBucketNotificationConfiguration API operation.

func (*PutBucketNotificationConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketNotificationConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketNotificationConfiguration request.

type PutBucketNotificationInput

type PutBucketNotificationInput struct {

	// The name of the bucket.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The container for the configuration.
	//
	// NotificationConfiguration is a required field
	NotificationConfiguration *NotificationConfigurationDeprecated `locationName:"NotificationConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketNotificationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketNotificationInput) String

String returns the string representation

func (*PutBucketNotificationInput) Validate

func (s *PutBucketNotificationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketNotificationOutput

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

func (PutBucketNotificationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketNotificationOutput) String

String returns the string representation

type PutBucketNotificationRequest

type PutBucketNotificationRequest struct {
	*aws.Request
	Input *PutBucketNotificationInput
	Copy  func(*PutBucketNotificationInput) PutBucketNotificationRequest
}

PutBucketNotificationRequest is the request type for the PutBucketNotification API operation.

func (PutBucketNotificationRequest) Send

Send marshals and sends the PutBucketNotification API request.

type PutBucketNotificationResponse added in v0.9.0

type PutBucketNotificationResponse struct {
	*PutBucketNotificationOutput
	// contains filtered or unexported fields
}

PutBucketNotificationResponse is the response type for the PutBucketNotification API operation.

func (*PutBucketNotificationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketNotificationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketNotification request.

type PutBucketPolicyInput

type PutBucketPolicyInput struct {

	// The name of the bucket.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Set this parameter to true to confirm that you want to remove your permissions
	// to change this bucket policy in the future.
	ConfirmRemoveSelfBucketAccess *bool `location:"header" locationName:"x-amz-confirm-remove-self-bucket-access" type:"boolean"`

	// The bucket policy as a JSON document.
	//
	// Policy is a required field
	Policy *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBucketPolicyInput) MarshalFields added in v0.3.0

func (s PutBucketPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketPolicyInput) String

func (s PutBucketPolicyInput) String() string

String returns the string representation

func (*PutBucketPolicyInput) Validate

func (s *PutBucketPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketPolicyOutput

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

func (PutBucketPolicyOutput) MarshalFields added in v0.3.0

func (s PutBucketPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketPolicyOutput) String

func (s PutBucketPolicyOutput) String() string

String returns the string representation

type PutBucketPolicyRequest

type PutBucketPolicyRequest struct {
	*aws.Request
	Input *PutBucketPolicyInput
	Copy  func(*PutBucketPolicyInput) PutBucketPolicyRequest
}

PutBucketPolicyRequest is the request type for the PutBucketPolicy API operation.

func (PutBucketPolicyRequest) Send

Send marshals and sends the PutBucketPolicy API request.

type PutBucketPolicyResponse added in v0.9.0

type PutBucketPolicyResponse struct {
	*PutBucketPolicyOutput
	// contains filtered or unexported fields
}

PutBucketPolicyResponse is the response type for the PutBucketPolicy API operation.

func (*PutBucketPolicyResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketPolicy request.

type PutBucketReplicationInput

type PutBucketReplicationInput struct {

	// The name of the bucket
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// A container for replication rules. You can add up to 1,000 rules. The maximum
	// size of a replication configuration is 2 MB.
	//
	// ReplicationConfiguration is a required field
	ReplicationConfiguration *ReplicationConfiguration `locationName:"ReplicationConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	Token *string `location:"header" locationName:"x-amz-bucket-object-lock-token" type:"string"`
	// contains filtered or unexported fields
}

func (PutBucketReplicationInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketReplicationInput) String

func (s PutBucketReplicationInput) String() string

String returns the string representation

func (*PutBucketReplicationInput) Validate

func (s *PutBucketReplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketReplicationOutput

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

func (PutBucketReplicationOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketReplicationOutput) String

String returns the string representation

type PutBucketReplicationRequest

type PutBucketReplicationRequest struct {
	*aws.Request
	Input *PutBucketReplicationInput
	Copy  func(*PutBucketReplicationInput) PutBucketReplicationRequest
}

PutBucketReplicationRequest is the request type for the PutBucketReplication API operation.

func (PutBucketReplicationRequest) Send

Send marshals and sends the PutBucketReplication API request.

type PutBucketReplicationResponse added in v0.9.0

type PutBucketReplicationResponse struct {
	*PutBucketReplicationOutput
	// contains filtered or unexported fields
}

PutBucketReplicationResponse is the response type for the PutBucketReplication API operation.

func (*PutBucketReplicationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketReplicationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketReplication request.

type PutBucketRequestPaymentInput

type PutBucketRequestPaymentInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Container for Payer.
	//
	// RequestPaymentConfiguration is a required field
	RequestPaymentConfiguration *RequestPaymentConfiguration `locationName:"RequestPaymentConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketRequestPaymentInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketRequestPaymentInput) String

String returns the string representation

func (*PutBucketRequestPaymentInput) Validate

func (s *PutBucketRequestPaymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketRequestPaymentOutput

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

func (PutBucketRequestPaymentOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketRequestPaymentOutput) String

String returns the string representation

type PutBucketRequestPaymentRequest

type PutBucketRequestPaymentRequest struct {
	*aws.Request
	Input *PutBucketRequestPaymentInput
	Copy  func(*PutBucketRequestPaymentInput) PutBucketRequestPaymentRequest
}

PutBucketRequestPaymentRequest is the request type for the PutBucketRequestPayment API operation.

func (PutBucketRequestPaymentRequest) Send

Send marshals and sends the PutBucketRequestPayment API request.

type PutBucketRequestPaymentResponse added in v0.9.0

type PutBucketRequestPaymentResponse struct {
	*PutBucketRequestPaymentOutput
	// contains filtered or unexported fields
}

PutBucketRequestPaymentResponse is the response type for the PutBucketRequestPayment API operation.

func (*PutBucketRequestPaymentResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketRequestPaymentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketRequestPayment request.

type PutBucketTaggingInput

type PutBucketTaggingInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Container for the TagSet and Tag elements.
	//
	// Tagging is a required field
	Tagging *Tagging `locationName:"Tagging" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketTaggingInput) MarshalFields added in v0.3.0

func (s PutBucketTaggingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketTaggingInput) String

func (s PutBucketTaggingInput) String() string

String returns the string representation

func (*PutBucketTaggingInput) Validate

func (s *PutBucketTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketTaggingOutput

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

func (PutBucketTaggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketTaggingOutput) String

func (s PutBucketTaggingOutput) String() string

String returns the string representation

type PutBucketTaggingRequest

type PutBucketTaggingRequest struct {
	*aws.Request
	Input *PutBucketTaggingInput
	Copy  func(*PutBucketTaggingInput) PutBucketTaggingRequest
}

PutBucketTaggingRequest is the request type for the PutBucketTagging API operation.

func (PutBucketTaggingRequest) Send

Send marshals and sends the PutBucketTagging API request.

type PutBucketTaggingResponse added in v0.9.0

type PutBucketTaggingResponse struct {
	*PutBucketTaggingOutput
	// contains filtered or unexported fields
}

PutBucketTaggingResponse is the response type for the PutBucketTagging API operation.

func (*PutBucketTaggingResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketTaggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketTagging request.

type PutBucketVersioningInput

type PutBucketVersioningInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The concatenation of the authentication device's serial number, a space,
	// and the value that is displayed on your authentication device.
	MFA *string `location:"header" locationName:"x-amz-mfa" type:"string"`

	// Container for setting the versioning state.
	//
	// VersioningConfiguration is a required field
	VersioningConfiguration *VersioningConfiguration `locationName:"VersioningConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketVersioningInput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketVersioningInput) String

func (s PutBucketVersioningInput) String() string

String returns the string representation

func (*PutBucketVersioningInput) Validate

func (s *PutBucketVersioningInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketVersioningOutput

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

func (PutBucketVersioningOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketVersioningOutput) String

func (s PutBucketVersioningOutput) String() string

String returns the string representation

type PutBucketVersioningRequest

type PutBucketVersioningRequest struct {
	*aws.Request
	Input *PutBucketVersioningInput
	Copy  func(*PutBucketVersioningInput) PutBucketVersioningRequest
}

PutBucketVersioningRequest is the request type for the PutBucketVersioning API operation.

func (PutBucketVersioningRequest) Send

Send marshals and sends the PutBucketVersioning API request.

type PutBucketVersioningResponse added in v0.9.0

type PutBucketVersioningResponse struct {
	*PutBucketVersioningOutput
	// contains filtered or unexported fields
}

PutBucketVersioningResponse is the response type for the PutBucketVersioning API operation.

func (*PutBucketVersioningResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketVersioningResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketVersioning request.

type PutBucketWebsiteInput

type PutBucketWebsiteInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Container for the request.
	//
	// WebsiteConfiguration is a required field
	WebsiteConfiguration *WebsiteConfiguration `locationName:"WebsiteConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
	// contains filtered or unexported fields
}

func (PutBucketWebsiteInput) MarshalFields added in v0.3.0

func (s PutBucketWebsiteInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketWebsiteInput) String

func (s PutBucketWebsiteInput) String() string

String returns the string representation

func (*PutBucketWebsiteInput) Validate

func (s *PutBucketWebsiteInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketWebsiteOutput

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

func (PutBucketWebsiteOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutBucketWebsiteOutput) String

func (s PutBucketWebsiteOutput) String() string

String returns the string representation

type PutBucketWebsiteRequest

type PutBucketWebsiteRequest struct {
	*aws.Request
	Input *PutBucketWebsiteInput
	Copy  func(*PutBucketWebsiteInput) PutBucketWebsiteRequest
}

PutBucketWebsiteRequest is the request type for the PutBucketWebsite API operation.

func (PutBucketWebsiteRequest) Send

Send marshals and sends the PutBucketWebsite API request.

type PutBucketWebsiteResponse added in v0.9.0

type PutBucketWebsiteResponse struct {
	*PutBucketWebsiteOutput
	// contains filtered or unexported fields
}

PutBucketWebsiteResponse is the response type for the PutBucketWebsite API operation.

func (*PutBucketWebsiteResponse) SDKResponseMetdata added in v0.9.0

func (r *PutBucketWebsiteResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutBucketWebsite request.

type PutObjectAclInput

type PutObjectAclInput struct {

	// The canned ACL to apply to the object. For more information, see Canned ACL
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
	ACL ObjectCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`

	// Contains the elements that set the ACL permissions for an object per grantee.
	AccessControlPolicy *AccessControlPolicy `locationName:"AccessControlPolicy" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// The bucket name that contains the object to which you want to attach the
	// ACL.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Allows grantee the read, write, read ACP, and write ACP permissions on the
	// bucket.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to list the objects in the bucket.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the bucket ACL.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to create, overwrite, and delete any object in the bucket.
	GrantWrite *string `location:"header" locationName:"x-amz-grant-write" type:"string"`

	// Allows grantee to write the ACL for the applicable bucket.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

	// Key for which the PUT operation was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// VersionId used to reference a specific version of the object.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectAclInput) MarshalFields added in v0.3.0

func (s PutObjectAclInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectAclInput) String

func (s PutObjectAclInput) String() string

String returns the string representation

func (*PutObjectAclInput) Validate

func (s *PutObjectAclInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectAclOutput

type PutObjectAclOutput struct {

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (PutObjectAclOutput) MarshalFields added in v0.3.0

func (s PutObjectAclOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectAclOutput) String

func (s PutObjectAclOutput) String() string

String returns the string representation

type PutObjectAclRequest

type PutObjectAclRequest struct {
	*aws.Request
	Input *PutObjectAclInput
	Copy  func(*PutObjectAclInput) PutObjectAclRequest
}

PutObjectAclRequest is the request type for the PutObjectAcl API operation.

func (PutObjectAclRequest) Send

Send marshals and sends the PutObjectAcl API request.

type PutObjectAclResponse added in v0.9.0

type PutObjectAclResponse struct {
	*PutObjectAclOutput
	// contains filtered or unexported fields
}

PutObjectAclResponse is the response type for the PutObjectAcl API operation.

func (*PutObjectAclResponse) SDKResponseMetdata added in v0.9.0

func (r *PutObjectAclResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutObjectAcl request.

type PutObjectInput

type PutObjectInput struct {

	// The canned ACL to apply to the object. For more information, see Canned ACL
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
	ACL ObjectCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`

	// Object data.
	Body io.ReadSeeker `type:"blob"`

	// Bucket name to which the PUT operation was initiated.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Can be used to specify caching behavior along the request/reply chain. For
	// more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
	// (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
	CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

	// Specifies presentational information for the object. For more information,
	// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1).
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// Specifies what content encodings have been applied to the object and thus
	// what decoding mechanisms must be applied to obtain the media-type referenced
	// by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
	// (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11).
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The language the content is in.
	ContentLanguage *string `location:"header" locationName:"Content-Language" type:"string"`

	// Size of the body in bytes. This parameter is useful when the size of the
	// body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
	// (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13).
	ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

	// The base64-encoded 128-bit MD5 digest of the message (without the headers)
	// according to RFC 1864. This header can be used as a message integrity check
	// to verify that the data is the same data that was originally sent. Although
	// it is optional, we recommend using the Content-MD5 mechanism as an end-to-end
	// integrity check. For more information about REST request authentication,
	// see REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
	ContentMD5 *string `location:"header" locationName:"Content-MD5" type:"string"`

	// A standard MIME type describing the format of the contents. For more information,
	// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// The date and time at which the object is no longer cacheable. For more information,
	// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21).
	Expires *time.Time `location:"header" locationName:"Expires" type:"timestamp"`

	// Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to read the object data and its metadata.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the object ACL.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to write the ACL for the applicable object.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

	// Object key for which the PUT operation was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// A map of metadata to store with the object in S3.
	Metadata map[string]string `location:"headers" locationName:"x-amz-meta-" type:"map"`

	// Specifies whether a legal hold will be applied to this object. For more information
	// about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
	ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"true"`

	// The Object Lock mode that you want to apply to this object.
	ObjectLockMode ObjectLockMode `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"true"`

	// The date and time when you want this object's Object Lock to expire.
	ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// Specifies the AWS KMS Encryption Context to use for object encryption. The
	// value of this header is a base64-encoded UTF-8 string holding JSON with the
	// encryption context key-value pairs.
	SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"`

	// If x-amz-server-side-encryption is present and has the value of aws:kms,
	// this header specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetrical customer managed customer master key (CMK) that was used for
	// the object.
	//
	// If the value of x-amz-server-side-encryption is aws:kms, this header specifies
	// the ID of the symmetric customer managed AWS KMS CMK that will be used for
	// the object. If you specify x-amz-server-side-encryption:aws:kms, but do not
	// providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS
	// managed CMK in AWS to protect the data.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// If you don't specify, S3 Standard is the default storage class. Amazon S3
	// supports other storage classes.
	StorageClass StorageClass `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"true"`

	// The tag-set for the object. The tag-set must be encoded as URL Query parameters.
	// (For example, "Key1=Value1")
	Tagging *string `location:"header" locationName:"x-amz-tagging" type:"string"`

	// If the bucket is configured as a website, redirects requests for this object
	// to another object in the same bucket or to an external URL. Amazon S3 stores
	// the value of this header in the object metadata. For information about object
	// metadata, see Object Key and Metadata (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html).
	//
	// In the following example, the request header sets the redirect to an object
	// (anotherPage.html) in the same bucket:
	//
	// x-amz-website-redirect-location: /anotherPage.html
	//
	// In the following example, the request header sets the object redirect to
	// another website:
	//
	// x-amz-website-redirect-location: http://www.example.com/
	//
	// For more information about website hosting in Amazon S3, see Hosting Websites
	// on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)
	// and How to Configure Website Page Redirects (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html).
	WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectInput) MarshalFields added in v0.3.0

func (s PutObjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectInput) String

func (s PutObjectInput) String() string

String returns the string representation

func (*PutObjectInput) Validate

func (s *PutObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectLegalHoldInput added in v0.6.0

type PutObjectLegalHoldInput struct {

	// The bucket name containing the object that you want to place a Legal Hold
	// on.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The key name for the object that you want to place a Legal Hold on.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Container element for the Legal Hold configuration you want to apply to the
	// specified object.
	LegalHold *ObjectLockLegalHold `locationName:"LegalHold" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// The version ID of the object that you want to place a Legal Hold on.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectLegalHoldInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectLegalHoldInput) String added in v0.6.0

func (s PutObjectLegalHoldInput) String() string

String returns the string representation

func (*PutObjectLegalHoldInput) Validate added in v0.6.0

func (s *PutObjectLegalHoldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectLegalHoldOutput added in v0.6.0

type PutObjectLegalHoldOutput struct {

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (PutObjectLegalHoldOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectLegalHoldOutput) String added in v0.6.0

func (s PutObjectLegalHoldOutput) String() string

String returns the string representation

type PutObjectLegalHoldRequest added in v0.6.0

type PutObjectLegalHoldRequest struct {
	*aws.Request
	Input *PutObjectLegalHoldInput
	Copy  func(*PutObjectLegalHoldInput) PutObjectLegalHoldRequest
}

PutObjectLegalHoldRequest is the request type for the PutObjectLegalHold API operation.

func (PutObjectLegalHoldRequest) Send added in v0.6.0

Send marshals and sends the PutObjectLegalHold API request.

type PutObjectLegalHoldResponse added in v0.9.0

type PutObjectLegalHoldResponse struct {
	*PutObjectLegalHoldOutput
	// contains filtered or unexported fields
}

PutObjectLegalHoldResponse is the response type for the PutObjectLegalHold API operation.

func (*PutObjectLegalHoldResponse) SDKResponseMetdata added in v0.9.0

func (r *PutObjectLegalHoldResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutObjectLegalHold request.

type PutObjectLockConfigurationInput added in v0.6.0

type PutObjectLockConfigurationInput struct {

	// The bucket whose Object Lock configuration you want to create or replace.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The Object Lock configuration that you want to apply to the specified bucket.
	ObjectLockConfiguration *ObjectLockConfiguration `locationName:"ObjectLockConfiguration" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// A token to allow Object Lock to be enabled for an existing bucket.
	Token *string `location:"header" locationName:"x-amz-bucket-object-lock-token" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectLockConfigurationInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectLockConfigurationInput) String added in v0.6.0

String returns the string representation

func (*PutObjectLockConfigurationInput) Validate added in v0.6.0

func (s *PutObjectLockConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectLockConfigurationOutput added in v0.6.0

type PutObjectLockConfigurationOutput struct {

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (PutObjectLockConfigurationOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectLockConfigurationOutput) String added in v0.6.0

String returns the string representation

type PutObjectLockConfigurationRequest added in v0.6.0

type PutObjectLockConfigurationRequest struct {
	*aws.Request
	Input *PutObjectLockConfigurationInput
	Copy  func(*PutObjectLockConfigurationInput) PutObjectLockConfigurationRequest
}

PutObjectLockConfigurationRequest is the request type for the PutObjectLockConfiguration API operation.

func (PutObjectLockConfigurationRequest) Send added in v0.6.0

Send marshals and sends the PutObjectLockConfiguration API request.

type PutObjectLockConfigurationResponse added in v0.9.0

type PutObjectLockConfigurationResponse struct {
	*PutObjectLockConfigurationOutput
	// contains filtered or unexported fields
}

PutObjectLockConfigurationResponse is the response type for the PutObjectLockConfiguration API operation.

func (*PutObjectLockConfigurationResponse) SDKResponseMetdata added in v0.9.0

func (r *PutObjectLockConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutObjectLockConfiguration request.

type PutObjectOutput

type PutObjectOutput struct {

	// Entity tag for the uploaded object.
	ETag *string `location:"header" locationName:"ETag" type:"string"`

	// If the expiration is configured for the object (see PutBucketLifecycleConfiguration),
	// the response includes this header. It includes the expiry-date and rule-id
	// key-value pairs that provide information about object expiration. The value
	// of the rule-id is URL encoded.
	Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the AWS KMS Encryption Context to use for object encryption.
	// The value of this header is a base64-encoded UTF-8 string holding JSON with
	// the encryption context key-value pairs.
	SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"`

	// If x-amz-server-side-encryption is present and has the value of aws:kms,
	// this header specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// If you specified server-side encryption either with an AWS KMS customer master
	// key (CMK) or Amazon S3-managed encryption key in your PUT request, the response
	// includes this header. It confirms the encryption algorithm that Amazon S3
	// used to encrypt the object.
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`

	// Version of the object.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectOutput) MarshalFields added in v0.3.0

func (s PutObjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectOutput) String

func (s PutObjectOutput) String() string

String returns the string representation

type PutObjectRequest

type PutObjectRequest struct {
	*aws.Request
	Input *PutObjectInput
	Copy  func(*PutObjectInput) PutObjectRequest
}

PutObjectRequest is the request type for the PutObject API operation.

func (PutObjectRequest) Send

Send marshals and sends the PutObject API request.

type PutObjectResponse added in v0.9.0

type PutObjectResponse struct {
	*PutObjectOutput
	// contains filtered or unexported fields
}

PutObjectResponse is the response type for the PutObject API operation.

func (*PutObjectResponse) SDKResponseMetdata added in v0.9.0

func (r *PutObjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutObject request.

type PutObjectRetentionInput added in v0.6.0

type PutObjectRetentionInput struct {

	// The bucket name that contains the object you want to apply this Object Retention
	// configuration to.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Indicates whether this operation should bypass Governance-mode restrictions.
	BypassGovernanceRetention *bool `location:"header" locationName:"x-amz-bypass-governance-retention" type:"boolean"`

	// The key name for the object that you want to apply this Object Retention
	// configuration to.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// The container element for the Object Retention configuration.
	Retention *ObjectLockRetention `locationName:"Retention" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// The version ID for the object that you want to apply this Object Retention
	// configuration to.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectRetentionInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectRetentionInput) String added in v0.6.0

func (s PutObjectRetentionInput) String() string

String returns the string representation

func (*PutObjectRetentionInput) Validate added in v0.6.0

func (s *PutObjectRetentionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectRetentionOutput added in v0.6.0

type PutObjectRetentionOutput struct {

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (PutObjectRetentionOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectRetentionOutput) String added in v0.6.0

func (s PutObjectRetentionOutput) String() string

String returns the string representation

type PutObjectRetentionRequest added in v0.6.0

type PutObjectRetentionRequest struct {
	*aws.Request
	Input *PutObjectRetentionInput
	Copy  func(*PutObjectRetentionInput) PutObjectRetentionRequest
}

PutObjectRetentionRequest is the request type for the PutObjectRetention API operation.

func (PutObjectRetentionRequest) Send added in v0.6.0

Send marshals and sends the PutObjectRetention API request.

type PutObjectRetentionResponse added in v0.9.0

type PutObjectRetentionResponse struct {
	*PutObjectRetentionOutput
	// contains filtered or unexported fields
}

PutObjectRetentionResponse is the response type for the PutObjectRetention API operation.

func (*PutObjectRetentionResponse) SDKResponseMetdata added in v0.9.0

func (r *PutObjectRetentionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutObjectRetention request.

type PutObjectTaggingInput

type PutObjectTaggingInput struct {

	// The bucket name containing the object.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Name of the tag.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Container for the TagSet and Tag elements
	//
	// Tagging is a required field
	Tagging *Tagging `locationName:"Tagging" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// The versionId of the object that the tag-set will be added to.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectTaggingInput) MarshalFields added in v0.3.0

func (s PutObjectTaggingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectTaggingInput) String

func (s PutObjectTaggingInput) String() string

String returns the string representation

func (*PutObjectTaggingInput) Validate

func (s *PutObjectTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectTaggingOutput

type PutObjectTaggingOutput struct {

	// The versionId of the object the tag-set was added to.
	VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`
	// contains filtered or unexported fields
}

func (PutObjectTaggingOutput) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutObjectTaggingOutput) String

func (s PutObjectTaggingOutput) String() string

String returns the string representation

type PutObjectTaggingRequest

type PutObjectTaggingRequest struct {
	*aws.Request
	Input *PutObjectTaggingInput
	Copy  func(*PutObjectTaggingInput) PutObjectTaggingRequest
}

PutObjectTaggingRequest is the request type for the PutObjectTagging API operation.

func (PutObjectTaggingRequest) Send

Send marshals and sends the PutObjectTagging API request.

type PutObjectTaggingResponse added in v0.9.0

type PutObjectTaggingResponse struct {
	*PutObjectTaggingOutput
	// contains filtered or unexported fields
}

PutObjectTaggingResponse is the response type for the PutObjectTagging API operation.

func (*PutObjectTaggingResponse) SDKResponseMetdata added in v0.9.0

func (r *PutObjectTaggingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutObjectTagging request.

type PutPublicAccessBlockInput added in v0.6.0

type PutPublicAccessBlockInput struct {

	// The name of the Amazon S3 bucket whose PublicAccessBlock configuration you
	// want to set.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// 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" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// PublicAccessBlockConfiguration is a required field
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (PutPublicAccessBlockInput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutPublicAccessBlockInput) String added in v0.6.0

func (s PutPublicAccessBlockInput) String() string

String returns the string representation

func (*PutPublicAccessBlockInput) Validate added in v0.6.0

func (s *PutPublicAccessBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPublicAccessBlockOutput added in v0.6.0

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

func (PutPublicAccessBlockOutput) MarshalFields added in v0.6.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutPublicAccessBlockOutput) String added in v0.6.0

String returns the string representation

type PutPublicAccessBlockRequest added in v0.6.0

type PutPublicAccessBlockRequest struct {
	*aws.Request
	Input *PutPublicAccessBlockInput
	Copy  func(*PutPublicAccessBlockInput) PutPublicAccessBlockRequest
}

PutPublicAccessBlockRequest is the request type for the PutPublicAccessBlock API operation.

func (PutPublicAccessBlockRequest) Send added in v0.6.0

Send marshals and sends the PutPublicAccessBlock API request.

type PutPublicAccessBlockResponse added in v0.9.0

type PutPublicAccessBlockResponse struct {
	*PutPublicAccessBlockOutput
	// contains filtered or unexported fields
}

PutPublicAccessBlockResponse is the response type for the PutPublicAccessBlock API operation.

func (*PutPublicAccessBlockResponse) SDKResponseMetdata added in v0.9.0

func (r *PutPublicAccessBlockResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutPublicAccessBlock request.

type QueueConfiguration

type QueueConfiguration struct {

	// A collection of bucket events for which to send notifications
	//
	// Events is a required field
	Events []Event `locationName:"Event" type:"list" flattened:"true" required:"true"`

	// Specifies object key name filtering rules. For information about key name
	// filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Filter *NotificationConfigurationFilter `type:"structure"`

	// An optional unique identifier for configurations in a notification configuration.
	// If you don't provide one, Amazon S3 will assign an ID.
	Id *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3
	// publishes a message when it detects events of the specified type.
	//
	// QueueArn is a required field
	QueueArn *string `locationName:"Queue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

func (QueueConfiguration) MarshalFields added in v0.3.0

func (s QueueConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (QueueConfiguration) String

func (s QueueConfiguration) String() string

String returns the string representation

func (*QueueConfiguration) Validate

func (s *QueueConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueueConfigurationDeprecated

type QueueConfigurationDeprecated struct {

	// The bucket event for which to send notifications.
	Event Event `deprecated:"true" type:"string" enum:"true"`

	// A collection of bucket events for which to send notifications
	Events []Event `locationName:"Event" type:"list" flattened:"true"`

	// An optional unique identifier for configurations in a notification configuration.
	// If you don't provide one, Amazon S3 will assign an ID.
	Id *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3
	// publishes a message when it detects events of the specified type.
	Queue *string `type:"string"`
	// contains filtered or unexported fields
}

This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

func (QueueConfigurationDeprecated) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (QueueConfigurationDeprecated) String

String returns the string representation

type QuoteFields added in v0.2.0

type QuoteFields string
const (
	QuoteFieldsAlways   QuoteFields = "ALWAYS"
	QuoteFieldsAsneeded QuoteFields = "ASNEEDED"
)

Enum values for QuoteFields

func (QuoteFields) MarshalValue added in v0.3.0

func (enum QuoteFields) MarshalValue() (string, error)

func (QuoteFields) MarshalValueBuf added in v0.3.0

func (enum QuoteFields) MarshalValueBuf(b []byte) ([]byte, error)

type Redirect

type Redirect struct {

	// The host name to use in the redirect request.
	HostName *string `type:"string"`

	// The HTTP redirect code to use on the response. Not required if one of the
	// siblings is present.
	HttpRedirectCode *string `type:"string"`

	// Protocol to use when redirecting requests. The default is the protocol that
	// is used in the original request.
	Protocol Protocol `type:"string" enum:"true"`

	// The object key prefix to use in the redirect request. For example, to redirect
	// requests for all pages with prefix docs/ (objects in the docs/ folder) to
	// documents/, you can set a condition block with KeyPrefixEquals set to docs/
	// and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required
	// if one of the siblings is present. Can be present only if ReplaceKeyWith
	// is not provided.
	ReplaceKeyPrefixWith *string `type:"string"`

	// The specific object key to use in the redirect request. For example, redirect
	// request to error.html. Not required if one of the siblings is present. Can
	// be present only if ReplaceKeyPrefixWith is not provided.
	ReplaceKeyWith *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

func (Redirect) MarshalFields added in v0.3.0

func (s Redirect) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Redirect) String

func (s Redirect) String() string

String returns the string representation

type RedirectAllRequestsTo

type RedirectAllRequestsTo struct {

	// Name of the host where requests are redirected.
	//
	// HostName is a required field
	HostName *string `type:"string" required:"true"`

	// Protocol to use when redirecting requests. The default is the protocol that
	// is used in the original request.
	Protocol Protocol `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

func (RedirectAllRequestsTo) MarshalFields added in v0.3.0

func (s RedirectAllRequestsTo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RedirectAllRequestsTo) String

func (s RedirectAllRequestsTo) String() string

String returns the string representation

func (*RedirectAllRequestsTo) Validate

func (s *RedirectAllRequestsTo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReplicationConfiguration

type ReplicationConfiguration struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that Amazon S3 assumes when replicating objects. For more information,
	// see How to Set Up Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Role is a required field
	Role *string `type:"string" required:"true"`

	// A container for one or more replication rules. A replication configuration
	// must have at least one rule and can contain a maximum of 1,000 rules.
	//
	// Rules is a required field
	Rules []ReplicationRule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

func (ReplicationConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReplicationConfiguration) String

func (s ReplicationConfiguration) String() string

String returns the string representation

func (*ReplicationConfiguration) Validate

func (s *ReplicationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReplicationRule

type ReplicationRule struct {

	// Specifies whether Amazon S3 replicates the delete markers. If you specify
	// a Filter, you must specify this element. However, in the latest version of
	// replication configuration (when Filter is specified), Amazon S3 doesn't replicate
	// delete markers. Therefore, the DeleteMarkerReplication element can contain
	// only <Status>Disabled</Status>. For an example configuration, see Basic Rule
	// Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config).
	//
	// If you don't specify the Filter element, Amazon S3 assumes that the replication
	// configuration is the earlier version, V1. In the earlier version, Amazon
	// S3 handled replication of delete markers differently. For more information,
	// see Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
	DeleteMarkerReplication *DeleteMarkerReplication `type:"structure"`

	// A container for information about the replication destination and its configurations
	// including enabling the S3 Replication Time Control (S3 RTC).
	//
	// Destination is a required field
	Destination *Destination `type:"structure" required:"true"`

	// Optional configuration to replicate existing source bucket objects. For more
	// information, see Replicating Existing Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication)
	// in the Amazon S3 Developer Guide.
	ExistingObjectReplication *ExistingObjectReplication `type:"structure"`

	// 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.
	Filter *ReplicationRuleFilter `type:"structure"`

	// A unique identifier for the rule. The maximum value is 255 characters.
	ID *string `type:"string"`

	// An object key name prefix that identifies the object or objects to which
	// the rule applies. The maximum prefix length is 1,024 characters. To include
	// all objects in a bucket, specify an empty string.
	Prefix *string `deprecated:"true" type:"string"`

	// The priority associated with the rule. If you specify multiple rules in a
	// replication configuration, Amazon S3 prioritizes the rules to prevent conflicts
	// when filtering. If two or more rules identify the same object based on a
	// specified filter, the rule with higher priority takes precedence. For example:
	//
	//    * Same object quality prefix-based filter criteria if prefixes you specified
	//    in multiple rules overlap
	//
	//    * Same object qualify tag-based filter criteria specified in multiple
	//    rules
	//
	// For more information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Priority *int64 `type:"integer"`

	// 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 master key (CMK) stored in AWS Key Management Service (SSE-KMS).
	SourceSelectionCriteria *SourceSelectionCriteria `type:"structure"`

	// Specifies whether the rule is enabled.
	//
	// Status is a required field
	Status ReplicationRuleStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Specifies which Amazon S3 objects to replicate and where to store the replicas.

func (ReplicationRule) MarshalFields added in v0.3.0

func (s ReplicationRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReplicationRule) String

func (s ReplicationRule) String() string

String returns the string representation

func (*ReplicationRule) Validate

func (s *ReplicationRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReplicationRuleAndOperator added in v0.5.0

type ReplicationRuleAndOperator struct {

	// An object key name prefix that identifies the subset of objects to which
	// the rule applies.
	Prefix *string `type:"string"`

	// An array of tags containing key and value pairs.
	Tags []Tag `locationName:"Tag" locationNameList:"Tag" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

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

func (ReplicationRuleAndOperator) MarshalFields added in v0.5.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReplicationRuleAndOperator) String added in v0.5.0

String returns the string representation

func (*ReplicationRuleAndOperator) Validate added in v0.5.0

func (s *ReplicationRuleAndOperator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReplicationRuleFilter added in v0.5.0

type ReplicationRuleFilter struct {

	// 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.
	And *ReplicationRuleAndOperator `type:"structure"`

	// An object key name prefix that identifies the subset of objects to which
	// the rule applies.
	Prefix *string `type:"string"`

	// A container for specifying a tag key and value.
	//
	// The rule applies only to objects that have the tag in their tag set.
	Tag *Tag `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (ReplicationRuleFilter) MarshalFields added in v0.5.0

func (s ReplicationRuleFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReplicationRuleFilter) String added in v0.5.0

func (s ReplicationRuleFilter) String() string

String returns the string representation

func (*ReplicationRuleFilter) Validate added in v0.5.0

func (s *ReplicationRuleFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReplicationRuleStatus

type ReplicationRuleStatus string
const (
	ReplicationRuleStatusEnabled  ReplicationRuleStatus = "Enabled"
	ReplicationRuleStatusDisabled ReplicationRuleStatus = "Disabled"
)

Enum values for ReplicationRuleStatus

func (ReplicationRuleStatus) MarshalValue added in v0.3.0

func (enum ReplicationRuleStatus) MarshalValue() (string, error)

func (ReplicationRuleStatus) MarshalValueBuf added in v0.3.0

func (enum ReplicationRuleStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ReplicationStatus

type ReplicationStatus string
const (
	ReplicationStatusComplete ReplicationStatus = "COMPLETE"
	ReplicationStatusPending  ReplicationStatus = "PENDING"
	ReplicationStatusFailed   ReplicationStatus = "FAILED"
	ReplicationStatusReplica  ReplicationStatus = "REPLICA"
)

Enum values for ReplicationStatus

func (ReplicationStatus) MarshalValue added in v0.3.0

func (enum ReplicationStatus) MarshalValue() (string, error)

func (ReplicationStatus) MarshalValueBuf added in v0.3.0

func (enum ReplicationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ReplicationTime added in v0.17.0

type ReplicationTime struct {

	// Specifies whether the replication time is enabled.
	//
	// Status is a required field
	Status ReplicationTimeStatus `type:"string" required:"true" enum:"true"`

	// A container specifying the time by which replication should be complete for
	// all objects and operations on objects.
	//
	// Time is a required field
	Time *ReplicationTimeValue `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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.

func (ReplicationTime) MarshalFields added in v0.17.0

func (s ReplicationTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReplicationTime) String added in v0.17.0

func (s ReplicationTime) String() string

String returns the string representation

func (*ReplicationTime) Validate added in v0.17.0

func (s *ReplicationTime) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReplicationTimeStatus added in v0.17.0

type ReplicationTimeStatus string
const (
	ReplicationTimeStatusEnabled  ReplicationTimeStatus = "Enabled"
	ReplicationTimeStatusDisabled ReplicationTimeStatus = "Disabled"
)

Enum values for ReplicationTimeStatus

func (ReplicationTimeStatus) MarshalValue added in v0.17.0

func (enum ReplicationTimeStatus) MarshalValue() (string, error)

func (ReplicationTimeStatus) MarshalValueBuf added in v0.17.0

func (enum ReplicationTimeStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ReplicationTimeValue added in v0.17.0

type ReplicationTimeValue struct {

	// Contains an integer specifying time in minutes.
	//
	// Valid values: 15 minutes.
	Minutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

func (ReplicationTimeValue) MarshalFields added in v0.17.0

func (s ReplicationTimeValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReplicationTimeValue) String added in v0.17.0

func (s ReplicationTimeValue) String() string

String returns the string representation

type RequestCharged

type RequestCharged string

If present, indicates that the requester was successfully charged for the request.

const (
	RequestChargedRequester RequestCharged = "requester"
)

Enum values for RequestCharged

func (RequestCharged) MarshalValue added in v0.3.0

func (enum RequestCharged) MarshalValue() (string, error)

func (RequestCharged) MarshalValueBuf added in v0.3.0

func (enum RequestCharged) MarshalValueBuf(b []byte) ([]byte, error)

type RequestFailure

type RequestFailure interface {
	awserr.RequestFailure

	// Host ID is the S3 Host ID needed for debug, and contacting support
	HostID() string
}

A RequestFailure provides access to the S3 Request ID and Host ID values returned from API operation errors. Getting the error as a string will return the formated error with the same information as awserr.RequestFailure, while also adding the HostID value from the response.

type RequestPayer

type RequestPayer string

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the Amazon S3 Developer Guide.

const (
	RequestPayerRequester RequestPayer = "requester"
)

Enum values for RequestPayer

func (RequestPayer) MarshalValue added in v0.3.0

func (enum RequestPayer) MarshalValue() (string, error)

func (RequestPayer) MarshalValueBuf added in v0.3.0

func (enum RequestPayer) MarshalValueBuf(b []byte) ([]byte, error)

type RequestPaymentConfiguration

type RequestPaymentConfiguration struct {

	// Specifies who pays for the download and request fees.
	//
	// Payer is a required field
	Payer Payer `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Container for Payer.

func (RequestPaymentConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RequestPaymentConfiguration) String

String returns the string representation

func (*RequestPaymentConfiguration) Validate

func (s *RequestPaymentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreObjectInput

type RestoreObjectInput struct {

	// The bucket name or containing the object to restore.
	//
	// When using this API with an access point, you must direct requests to the
	// access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
	// When using this operation using an access point through the AWS SDKs, you
	// provide the access point ARN in place of the bucket name. For more information
	// about access point ARNs, see Using Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Object key for which the operation was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Container for restore job parameters.
	RestoreRequest *RestoreRequest `locationName:"RestoreRequest" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

	// VersionId used to reference a specific version of the object.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (RestoreObjectInput) MarshalFields added in v0.3.0

func (s RestoreObjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RestoreObjectInput) String

func (s RestoreObjectInput) String() string

String returns the string representation

func (*RestoreObjectInput) Validate

func (s *RestoreObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreObjectOutput

type RestoreObjectOutput struct {

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// Indicates the path in the provided S3 output location where Select results
	// will be restored to.
	RestoreOutputPath *string `location:"header" locationName:"x-amz-restore-output-path" type:"string"`
	// contains filtered or unexported fields
}

func (RestoreObjectOutput) MarshalFields added in v0.3.0

func (s RestoreObjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RestoreObjectOutput) String

func (s RestoreObjectOutput) String() string

String returns the string representation

type RestoreObjectRequest

type RestoreObjectRequest struct {
	*aws.Request
	Input *RestoreObjectInput
	Copy  func(*RestoreObjectInput) RestoreObjectRequest
}

RestoreObjectRequest is the request type for the RestoreObject API operation.

func (RestoreObjectRequest) Send

Send marshals and sends the RestoreObject API request.

type RestoreObjectResponse added in v0.9.0

type RestoreObjectResponse struct {
	*RestoreObjectOutput
	// contains filtered or unexported fields
}

RestoreObjectResponse is the response type for the RestoreObject API operation.

func (*RestoreObjectResponse) SDKResponseMetdata added in v0.9.0

func (r *RestoreObjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreObject request.

type RestoreRequest

type RestoreRequest struct {

	// Lifetime of the active copy in days. Do not use with restores that specify
	// OutputLocation.
	Days *int64 `type:"integer"`

	// The optional description for the job.
	Description *string `type:"string"`

	// S3 Glacier related parameters pertaining to this job. Do not use with restores
	// that specify OutputLocation.
	GlacierJobParameters *GlacierJobParameters `type:"structure"`

	// Describes the location where the restore job's output is stored.
	OutputLocation *OutputLocation `type:"structure"`

	// Describes the parameters for Select job types.
	SelectParameters *SelectParameters `type:"structure"`

	// S3 Glacier retrieval tier at which the restore will be processed.
	Tier Tier `type:"string" enum:"true"`

	// Type of restore request.
	Type RestoreRequestType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Container for restore job parameters.

func (RestoreRequest) MarshalFields added in v0.3.0

func (s RestoreRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RestoreRequest) String

func (s RestoreRequest) String() string

String returns the string representation

func (*RestoreRequest) Validate

func (s *RestoreRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreRequestType added in v0.2.0

type RestoreRequestType string
const (
	RestoreRequestTypeSelect RestoreRequestType = "SELECT"
)

Enum values for RestoreRequestType

func (RestoreRequestType) MarshalValue added in v0.3.0

func (enum RestoreRequestType) MarshalValue() (string, error)

func (RestoreRequestType) MarshalValueBuf added in v0.3.0

func (enum RestoreRequestType) MarshalValueBuf(b []byte) ([]byte, error)

type RoutingRule

type RoutingRule struct {

	// 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.
	Condition *Condition `type:"structure"`

	// Container for redirect information. You can redirect requests to another
	// host, to another page, or with another protocol. In the event of an error,
	// you can specify a different error code to return.
	//
	// Redirect is a required field
	Redirect *Redirect `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Specifies the redirect behavior and when a redirect is applied.

func (RoutingRule) MarshalFields added in v0.3.0

func (s RoutingRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RoutingRule) String

func (s RoutingRule) String() string

String returns the string representation

func (*RoutingRule) Validate

func (s *RoutingRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Rule

type Rule struct {

	// Specifies the days since the initiation of an incomplete multipart upload
	// that Amazon S3 will wait before permanently removing all parts of the upload.
	// For more information, see Aborting Incomplete Multipart Uploads Using a Bucket
	// Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config)
	// in the Amazon Simple Storage Service Developer Guide.
	AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload `type:"structure"`

	// Specifies the expiration for the lifecycle of the object.
	Expiration *LifecycleExpiration `type:"structure"`

	// Unique identifier for the rule. The value can't be longer than 255 characters.
	ID *string `type:"string"`

	// 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.
	NoncurrentVersionExpiration *NoncurrentVersionExpiration `type:"structure"`

	// 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. 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, or DEEP_ARCHIVE storage class at a specific period in the object's
	// lifetime.
	NoncurrentVersionTransition *NoncurrentVersionTransition `type:"structure"`

	// Object key prefix that identifies one or more objects to which this rule
	// applies.
	//
	// Prefix is a required field
	Prefix *string `type:"string" required:"true"`

	// If Enabled, the rule is currently being applied. If Disabled, the rule is
	// not currently being applied.
	//
	// Status is a required field
	Status ExpirationStatus `type:"string" required:"true" enum:"true"`

	// Specifies when an object transitions to a specified storage class. For more
	// information about Amazon S3 lifecycle configuration rules, see Transitioning
	// Objects Using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Transition *Transition `type:"structure"`
	// contains filtered or unexported fields
}

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the Amazon Simple Storage Service API Reference. For examples, see Put Bucket Lifecycle Configuration Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples)

func (Rule) MarshalFields added in v0.3.0

func (s Rule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Rule) String

func (s Rule) String() string

String returns the string representation

func (*Rule) Validate

func (s *Rule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3KeyFilter added in v0.9.0

type S3KeyFilter struct {

	// A list of containers for the key-value pair that defines the criteria for
	// the filter rule.
	FilterRules []FilterRule `locationName:"FilterRule" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

A container for object key name prefix and suffix filtering rules.

func (S3KeyFilter) MarshalFields added in v0.9.0

func (s S3KeyFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3KeyFilter) String added in v0.9.0

func (s S3KeyFilter) String() string

String returns the string representation

type S3Location added in v0.9.0

type S3Location struct {

	// A list of grants that control access to the staged results.
	AccessControlList []Grant `locationNameList:"Grant" type:"list"`

	// The name of the bucket where the restore results will be placed.
	//
	// BucketName is a required field
	BucketName *string `type:"string" required:"true"`

	// The canned ACL to apply to the restore results.
	CannedACL ObjectCannedACL `type:"string" enum:"true"`

	// Contains the type of server-side encryption used.
	Encryption *Encryption `type:"structure"`

	// The prefix that is prepended to the restore results for this request.
	//
	// Prefix is a required field
	Prefix *string `type:"string" required:"true"`

	// The class of storage used to store the restore results.
	StorageClass StorageClass `type:"string" enum:"true"`

	// The tag-set that is applied to the restore results.
	Tagging *Tagging `type:"structure"`

	// A list of metadata to store with the restore results in S3.
	UserMetadata []MetadataEntry `locationNameList:"MetadataEntry" type:"list"`
	// contains filtered or unexported fields
}

Describes an Amazon S3 location that will receive the results of the restore request.

func (S3Location) MarshalFields added in v0.9.0

func (s S3Location) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3Location) String added in v0.9.0

func (s S3Location) String() string

String returns the string representation

func (*S3Location) Validate added in v0.9.0

func (s *S3Location) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SSEKMS added in v0.2.0

type SSEKMS struct {

	// Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer
	// managed customer master key (CMK) to use for encrypting inventory reports.
	//
	// KeyId is a required field
	KeyId *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

func (SSEKMS) MarshalFields added in v0.3.0

func (s SSEKMS) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SSEKMS) String added in v0.2.0

func (s SSEKMS) String() string

String returns the string representation

func (*SSEKMS) Validate added in v0.2.0

func (s *SSEKMS) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SSES3 added in v0.2.0

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

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

func (SSES3) MarshalFields added in v0.3.0

func (s SSES3) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SSES3) String added in v0.2.0

func (s SSES3) String() string

String returns the string representation

type SelectParameters added in v0.2.0

type SelectParameters struct {

	// The expression that is used to query the object.
	//
	// Expression is a required field
	Expression *string `type:"string" required:"true"`

	// The type of the provided expression (for example, SQL).
	//
	// ExpressionType is a required field
	ExpressionType ExpressionType `type:"string" required:"true" enum:"true"`

	// Describes the serialization format of the object.
	//
	// InputSerialization is a required field
	InputSerialization *InputSerialization `type:"structure" required:"true"`

	// Describes how the results of the Select job are serialized.
	//
	// OutputSerialization is a required field
	OutputSerialization *OutputSerialization `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Describes the parameters for Select job types.

func (SelectParameters) MarshalFields added in v0.3.0

func (s SelectParameters) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SelectParameters) String added in v0.2.0

func (s SelectParameters) String() string

String returns the string representation

func (*SelectParameters) Validate added in v0.2.0

func (s *SelectParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServerSideEncryption

type ServerSideEncryption string
const (
	ServerSideEncryptionAes256 ServerSideEncryption = "AES256"
	ServerSideEncryptionAwsKms ServerSideEncryption = "aws:kms"
)

Enum values for ServerSideEncryption

func (ServerSideEncryption) MarshalValue added in v0.3.0

func (enum ServerSideEncryption) MarshalValue() (string, error)

func (ServerSideEncryption) MarshalValueBuf added in v0.3.0

func (enum ServerSideEncryption) MarshalValueBuf(b []byte) ([]byte, error)

type ServerSideEncryptionByDefault added in v0.2.0

type ServerSideEncryptionByDefault struct {

	// AWS Key Management Service (KMS) customer master key ID to use for the default
	// encryption. This parameter is allowed if and only if SSEAlgorithm is set
	// to aws:kms.
	//
	// You can specify the key ID or the Amazon Resource Name (ARN) of the CMK.
	// However, if you are using encryption with cross-account operations, you must
	// use a fully qualified CMK ARN. For more information, see Using encryption
	// for cross-account operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).
	//
	// For example:
	//
	//    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
	//
	//    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
	//
	// Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more
	// information, see Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)
	// in the AWS Key Management Service Developer Guide.
	KMSMasterKeyID *string `type:"string" sensitive:"true"`

	// Server-side encryption algorithm to use for the default encryption.
	//
	// SSEAlgorithm is a required field
	SSEAlgorithm ServerSideEncryption `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

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 PUT Bucket encryption (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the Amazon Simple Storage Service API Reference.

func (ServerSideEncryptionByDefault) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServerSideEncryptionByDefault) String added in v0.2.0

String returns the string representation

func (*ServerSideEncryptionByDefault) Validate added in v0.2.0

func (s *ServerSideEncryptionByDefault) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServerSideEncryptionConfiguration added in v0.2.0

type ServerSideEncryptionConfiguration struct {

	// Container for information about a particular server-side encryption configuration
	// rule.
	//
	// Rules is a required field
	Rules []ServerSideEncryptionRule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

Specifies the default server-side-encryption configuration.

func (ServerSideEncryptionConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServerSideEncryptionConfiguration) String added in v0.2.0

String returns the string representation

func (*ServerSideEncryptionConfiguration) Validate added in v0.2.0

Validate inspects the fields of the type to determine if they are valid.

type ServerSideEncryptionRule added in v0.2.0

type ServerSideEncryptionRule struct {

	// Specifies 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.
	ApplyServerSideEncryptionByDefault *ServerSideEncryptionByDefault `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the default server-side encryption configuration.

func (ServerSideEncryptionRule) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServerSideEncryptionRule) String added in v0.2.0

func (s ServerSideEncryptionRule) String() string

String returns the string representation

func (*ServerSideEncryptionRule) Validate added in v0.2.0

func (s *ServerSideEncryptionRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SourceSelectionCriteria added in v0.2.0

type SourceSelectionCriteria struct {

	// A container for filter information for the selection of Amazon S3 objects
	// encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication
	// configuration, this element is required.
	SseKmsEncryptedObjects *SseKmsEncryptedObjects `type:"structure"`
	// contains filtered or unexported fields
}

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 master key (CMK) stored in AWS Key Management Service (SSE-KMS).

func (SourceSelectionCriteria) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SourceSelectionCriteria) String added in v0.2.0

func (s SourceSelectionCriteria) String() string

String returns the string representation

func (*SourceSelectionCriteria) Validate added in v0.2.0

func (s *SourceSelectionCriteria) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SseKmsEncryptedObjects added in v0.2.0

type SseKmsEncryptedObjects struct {

	// Specifies whether Amazon S3 replicates objects created with server-side encryption
	// using a customer master key (CMK) stored in AWS Key Management Service.
	//
	// Status is a required field
	Status SseKmsEncryptedObjectsStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A container for filter information for the selection of S3 objects encrypted with AWS KMS.

func (SseKmsEncryptedObjects) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SseKmsEncryptedObjects) String added in v0.2.0

func (s SseKmsEncryptedObjects) String() string

String returns the string representation

func (*SseKmsEncryptedObjects) Validate added in v0.2.0

func (s *SseKmsEncryptedObjects) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SseKmsEncryptedObjectsStatus added in v0.2.0

type SseKmsEncryptedObjectsStatus string
const (
	SseKmsEncryptedObjectsStatusEnabled  SseKmsEncryptedObjectsStatus = "Enabled"
	SseKmsEncryptedObjectsStatusDisabled SseKmsEncryptedObjectsStatus = "Disabled"
)

Enum values for SseKmsEncryptedObjectsStatus

func (SseKmsEncryptedObjectsStatus) MarshalValue added in v0.3.0

func (enum SseKmsEncryptedObjectsStatus) MarshalValue() (string, error)

func (SseKmsEncryptedObjectsStatus) MarshalValueBuf added in v0.3.0

func (enum SseKmsEncryptedObjectsStatus) MarshalValueBuf(b []byte) ([]byte, error)

type StorageClass

type StorageClass string
const (
	StorageClassStandard           StorageClass = "STANDARD"
	StorageClassReducedRedundancy  StorageClass = "REDUCED_REDUNDANCY"
	StorageClassStandardIa         StorageClass = "STANDARD_IA"
	StorageClassOnezoneIa          StorageClass = "ONEZONE_IA"
	StorageClassIntelligentTiering StorageClass = "INTELLIGENT_TIERING"
	StorageClassGlacier            StorageClass = "GLACIER"
	StorageClassDeepArchive        StorageClass = "DEEP_ARCHIVE"
)

Enum values for StorageClass

func (StorageClass) MarshalValue added in v0.3.0

func (enum StorageClass) MarshalValue() (string, error)

func (StorageClass) MarshalValueBuf added in v0.3.0

func (enum StorageClass) MarshalValueBuf(b []byte) ([]byte, error)

type StorageClassAnalysis

type StorageClassAnalysis struct {

	// Specifies how data related to the storage class analysis for an Amazon S3
	// bucket should be exported.
	DataExport *StorageClassAnalysisDataExport `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (StorageClassAnalysis) MarshalFields added in v0.3.0

func (s StorageClassAnalysis) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StorageClassAnalysis) String

func (s StorageClassAnalysis) String() string

String returns the string representation

func (*StorageClassAnalysis) Validate

func (s *StorageClassAnalysis) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StorageClassAnalysisDataExport

type StorageClassAnalysisDataExport struct {

	// The place to store the data for an analysis.
	//
	// Destination is a required field
	Destination *AnalyticsExportDestination `type:"structure" required:"true"`

	// The version of the output schema to use when exporting data. Must be V_1.
	//
	// OutputSchemaVersion is a required field
	OutputSchemaVersion StorageClassAnalysisSchemaVersion `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Container for data related to the storage class analysis for an Amazon S3 bucket for export.

func (StorageClassAnalysisDataExport) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StorageClassAnalysisDataExport) String

String returns the string representation

func (*StorageClassAnalysisDataExport) Validate

func (s *StorageClassAnalysisDataExport) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StorageClassAnalysisSchemaVersion

type StorageClassAnalysisSchemaVersion string
const (
	StorageClassAnalysisSchemaVersionV1 StorageClassAnalysisSchemaVersion = "V_1"
)

Enum values for StorageClassAnalysisSchemaVersion

func (StorageClassAnalysisSchemaVersion) MarshalValue added in v0.3.0

func (enum StorageClassAnalysisSchemaVersion) MarshalValue() (string, error)

func (StorageClassAnalysisSchemaVersion) MarshalValueBuf added in v0.3.0

func (enum StorageClassAnalysisSchemaVersion) MarshalValueBuf(b []byte) ([]byte, error)

type Tag

type Tag struct {

	// Name of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Value of the tag.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A container of a key value name pair.

func (Tag) MarshalFields added in v0.3.0

func (s Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tagging

type Tagging struct {

	// A collection for a set of tags
	//
	// TagSet is a required field
	TagSet []Tag `locationNameList:"Tag" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Container for TagSet elements.

func (Tagging) MarshalFields added in v0.3.0

func (s Tagging) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tagging) String

func (s Tagging) String() string

String returns the string representation

func (*Tagging) Validate

func (s *Tagging) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TaggingDirective

type TaggingDirective string
const (
	TaggingDirectiveCopy    TaggingDirective = "COPY"
	TaggingDirectiveReplace TaggingDirective = "REPLACE"
)

Enum values for TaggingDirective

func (TaggingDirective) MarshalValue added in v0.3.0

func (enum TaggingDirective) MarshalValue() (string, error)

func (TaggingDirective) MarshalValueBuf added in v0.3.0

func (enum TaggingDirective) MarshalValueBuf(b []byte) ([]byte, error)

type TargetGrant

type TargetGrant struct {

	// Container for the person being granted permissions.
	Grantee *Grantee `type:"structure" xmlPrefix:"xsi" xmlURI:"http://www.w3.org/2001/XMLSchema-instance"`

	// Logging permissions assigned to the Grantee for the bucket.
	Permission BucketLogsPermission `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Container for granting information.

func (TargetGrant) MarshalFields added in v0.3.0

func (s TargetGrant) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TargetGrant) String

func (s TargetGrant) String() string

String returns the string representation

func (*TargetGrant) Validate

func (s *TargetGrant) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tier

type Tier string
const (
	TierStandard  Tier = "Standard"
	TierBulk      Tier = "Bulk"
	TierExpedited Tier = "Expedited"
)

Enum values for Tier

func (Tier) MarshalValue added in v0.3.0

func (enum Tier) MarshalValue() (string, error)

func (Tier) MarshalValueBuf added in v0.3.0

func (enum Tier) MarshalValueBuf(b []byte) ([]byte, error)

type TopicConfiguration

type TopicConfiguration struct {

	// The Amazon S3 bucket event about which to send notifications. For more information,
	// see Supported Event Types (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Events is a required field
	Events []Event `locationName:"Event" type:"list" flattened:"true" required:"true"`

	// Specifies object key name filtering rules. For information about key name
	// filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
	// in the Amazon Simple Storage Service Developer Guide.
	Filter *NotificationConfigurationFilter `type:"structure"`

	// An optional unique identifier for configurations in a notification configuration.
	// If you don't provide one, Amazon S3 will assign an ID.
	Id *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3
	// publishes a message when it detects events of the specified type.
	//
	// TopicArn is a required field
	TopicArn *string `locationName:"Topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (TopicConfiguration) MarshalFields added in v0.3.0

func (s TopicConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TopicConfiguration) String

func (s TopicConfiguration) String() string

String returns the string representation

func (*TopicConfiguration) Validate

func (s *TopicConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TopicConfigurationDeprecated

type TopicConfigurationDeprecated struct {

	// Bucket event for which to send notifications.
	Event Event `deprecated:"true" type:"string" enum:"true"`

	// A collection of events related to objects
	Events []Event `locationName:"Event" type:"list" flattened:"true"`

	// An optional unique identifier for configurations in a notification configuration.
	// If you don't provide one, Amazon S3 will assign an ID.
	Id *string `type:"string"`

	// Amazon SNS topic to which Amazon S3 will publish a message to report the
	// specified events for the bucket.
	Topic *string `type:"string"`
	// contains filtered or unexported fields
}

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. This data type is deprecated. Use TopicConfiguration instead.

func (TopicConfigurationDeprecated) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TopicConfigurationDeprecated) String

String returns the string representation

type Transition

type Transition struct {

	// Indicates when objects are transitioned to the specified storage class. The
	// date value must be in ISO 8601 format. The time is always midnight UTC.
	Date *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Indicates the number of days after creation when objects are transitioned
	// to the specified storage class. The value must be a positive integer.
	Days *int64 `type:"integer"`

	// The storage class to which you want the object to transition.
	StorageClass TransitionStorageClass `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the Amazon Simple Storage Service Developer Guide.

func (Transition) MarshalFields added in v0.3.0

func (s Transition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Transition) String

func (s Transition) String() string

String returns the string representation

type TransitionStorageClass

type TransitionStorageClass string
const (
	TransitionStorageClassGlacier            TransitionStorageClass = "GLACIER"
	TransitionStorageClassStandardIa         TransitionStorageClass = "STANDARD_IA"
	TransitionStorageClassOnezoneIa          TransitionStorageClass = "ONEZONE_IA"
	TransitionStorageClassIntelligentTiering TransitionStorageClass = "INTELLIGENT_TIERING"
	TransitionStorageClassDeepArchive        TransitionStorageClass = "DEEP_ARCHIVE"
)

Enum values for TransitionStorageClass

func (TransitionStorageClass) MarshalValue added in v0.3.0

func (enum TransitionStorageClass) MarshalValue() (string, error)

func (TransitionStorageClass) MarshalValueBuf added in v0.3.0

func (enum TransitionStorageClass) MarshalValueBuf(b []byte) ([]byte, error)

type Type

type Type string
const (
	TypeCanonicalUser         Type = "CanonicalUser"
	TypeAmazonCustomerByEmail Type = "AmazonCustomerByEmail"
	TypeGroup                 Type = "Group"
)

Enum values for Type

func (Type) MarshalValue added in v0.3.0

func (enum Type) MarshalValue() (string, error)

func (Type) MarshalValueBuf added in v0.3.0

func (enum Type) MarshalValueBuf(b []byte) ([]byte, error)

type UploadPartCopyInput

type UploadPartCopyInput struct {

	// The bucket name.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// The name of the source bucket and key name of the source object, separated
	// by a slash (/). Must be URL-encoded.
	//
	// CopySource is a required field
	CopySource *string `location:"header" locationName:"x-amz-copy-source" type:"string" required:"true"`

	// Copies the object if its entity tag (ETag) matches the specified tag.
	CopySourceIfMatch *string `location:"header" locationName:"x-amz-copy-source-if-match" type:"string"`

	// Copies the object if it has been modified since the specified time.
	CopySourceIfModifiedSince *time.Time `location:"header" locationName:"x-amz-copy-source-if-modified-since" type:"timestamp"`

	// Copies the object if its entity tag (ETag) is different than the specified
	// ETag.
	CopySourceIfNoneMatch *string `location:"header" locationName:"x-amz-copy-source-if-none-match" type:"string"`

	// Copies the object if it hasn't been modified since the specified time.
	CopySourceIfUnmodifiedSince *time.Time `location:"header" locationName:"x-amz-copy-source-if-unmodified-since" type:"timestamp"`

	// The range of bytes to copy from the source object. The range value must use
	// the form bytes=first-last, where the first and last are the zero-based byte
	// offsets to copy. For example, bytes=0-9 indicates that you want to copy the
	// first 10 bytes of the source. You can copy a range only if the source object
	// is greater than 5 MB.
	CopySourceRange *string `location:"header" locationName:"x-amz-copy-source-range" type:"string"`

	// Specifies the algorithm to use when decrypting the source object (for example,
	// AES256).
	CopySourceSSECustomerAlgorithm *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use to decrypt
	// the source object. The encryption key provided in this header must be one
	// that was used when the source object was created.
	CopySourceSSECustomerKey *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	CopySourceSSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-key-MD5" type:"string"`

	// Object key for which the multipart upload was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Part number of part being copied. This is a positive integer between 1 and
	// 10,000.
	//
	// PartNumber is a required field
	PartNumber *int64 `location:"querystring" locationName:"partNumber" type:"integer" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header. This must be the same encryption key specified in the initiate multipart
	// upload request.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// Upload ID identifying the multipart upload whose part is being copied.
	//
	// UploadId is a required field
	UploadId *string `location:"querystring" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UploadPartCopyInput) MarshalFields added in v0.3.0

func (s UploadPartCopyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UploadPartCopyInput) String

func (s UploadPartCopyInput) String() string

String returns the string representation

func (*UploadPartCopyInput) Validate

func (s *UploadPartCopyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UploadPartCopyOutput

type UploadPartCopyOutput struct {

	// Container for all response elements.
	CopyPartResult *CopyPartResult `type:"structure"`

	// The version of the source object that was copied, if you have enabled versioning
	// on the source bucket.
	CopySourceVersionId *string `location:"header" locationName:"x-amz-copy-source-version-id" type:"string"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) that was used for the
	// object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UploadPartCopyOutput) MarshalFields added in v0.3.0

func (s UploadPartCopyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UploadPartCopyOutput) String

func (s UploadPartCopyOutput) String() string

String returns the string representation

type UploadPartCopyRequest

type UploadPartCopyRequest struct {
	*aws.Request
	Input *UploadPartCopyInput
	Copy  func(*UploadPartCopyInput) UploadPartCopyRequest
}

UploadPartCopyRequest is the request type for the UploadPartCopy API operation.

func (UploadPartCopyRequest) Send

Send marshals and sends the UploadPartCopy API request.

type UploadPartCopyResponse added in v0.9.0

type UploadPartCopyResponse struct {
	*UploadPartCopyOutput
	// contains filtered or unexported fields
}

UploadPartCopyResponse is the response type for the UploadPartCopy API operation.

func (*UploadPartCopyResponse) SDKResponseMetdata added in v0.9.0

func (r *UploadPartCopyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UploadPartCopy request.

type UploadPartInput

type UploadPartInput struct {

	// Object data.
	Body io.ReadSeeker `type:"blob"`

	// Name of the bucket to which the multipart upload was initiated.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

	// Size of the body in bytes. This parameter is useful when the size of the
	// body cannot be determined automatically.
	ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

	// The base64-encoded 128-bit MD5 digest of the part data. This parameter is
	// auto-populated when using the command from the CLI. This parameter is required
	// if object lock parameters are specified.
	ContentMD5 *string `location:"header" locationName:"Content-MD5" type:"string"`

	// Object key for which the multipart upload was initiated.
	//
	// Key is a required field
	Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

	// Part number of part being uploaded. This is a positive integer between 1
	// and 10,000.
	//
	// PartNumber is a required field
	PartNumber *int64 `location:"querystring" locationName:"partNumber" type:"integer" required:"true"`

	// Confirms that the requester knows that they will be charged for the request.
	// Bucket owners need not specify this parameter in their requests. For information
	// about downloading objects from requester pays buckets, see Downloading Objects
	// in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
	// in the Amazon S3 Developer Guide.
	RequestPayer RequestPayer `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"true"`

	// Specifies the algorithm to use to when encrypting the object (for example,
	// AES256).
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// Specifies the customer-provided encryption key for Amazon S3 to use in encrypting
	// data. This value is used to store the object and then it is discarded; Amazon
	// S3 does not store the encryption key. The key must be appropriate for use
	// with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
	// header. This must be the same encryption key specified in the initiate multipart
	// upload request.
	SSECustomerKey *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

	// Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
	// Amazon S3 uses this header for a message integrity check to ensure that the
	// encryption key was transmitted without error.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// Upload ID identifying the multipart upload whose part is being uploaded.
	//
	// UploadId is a required field
	UploadId *string `location:"querystring" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UploadPartInput) MarshalFields added in v0.3.0

func (s UploadPartInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UploadPartInput) String

func (s UploadPartInput) String() string

String returns the string representation

func (*UploadPartInput) Validate

func (s *UploadPartInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UploadPartOutput

type UploadPartOutput struct {

	// Entity tag for the uploaded object.
	ETag *string `location:"header" locationName:"ETag" type:"string"`

	// If present, indicates that the requester was successfully charged for the
	// request.
	RequestCharged RequestCharged `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"true"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header confirming the encryption algorithm
	// used.
	SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

	// If server-side encryption with a customer-provided encryption key was requested,
	// the response will include this header to provide round-trip message integrity
	// verification of the customer-provided encryption key.
	SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

	// If present, specifies the ID of the AWS Key Management Service (AWS KMS)
	// symmetric customer managed customer master key (CMK) was used for the object.
	SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

	// The server-side encryption algorithm used when storing this object in Amazon
	// S3 (for example, AES256, aws:kms).
	ServerSideEncryption ServerSideEncryption `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UploadPartOutput) MarshalFields added in v0.3.0

func (s UploadPartOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UploadPartOutput) String

func (s UploadPartOutput) String() string

String returns the string representation

type UploadPartRequest

type UploadPartRequest struct {
	*aws.Request
	Input *UploadPartInput
	Copy  func(*UploadPartInput) UploadPartRequest
}

UploadPartRequest is the request type for the UploadPart API operation.

func (UploadPartRequest) Send

Send marshals and sends the UploadPart API request.

type UploadPartResponse added in v0.9.0

type UploadPartResponse struct {
	*UploadPartOutput
	// contains filtered or unexported fields
}

UploadPartResponse is the response type for the UploadPart API operation.

func (*UploadPartResponse) SDKResponseMetdata added in v0.9.0

func (r *UploadPartResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UploadPart request.

type VersioningConfiguration

type VersioningConfiguration struct {

	// Specifies whether MFA delete is enabled in the bucket versioning configuration.
	// This element is only returned if the bucket has been configured with MFA
	// delete. If the bucket has never been so configured, this element is not returned.
	MFADelete MFADelete `locationName:"MfaDelete" type:"string" enum:"true"`

	// The versioning state of the bucket.
	Status BucketVersioningStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the Amazon Simple Storage Service API Reference.

func (VersioningConfiguration) MarshalFields added in v0.3.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VersioningConfiguration) String

func (s VersioningConfiguration) String() string

String returns the string representation

type WebsiteConfiguration

type WebsiteConfiguration struct {

	// The name of the error document for the website.
	ErrorDocument *ErrorDocument `type:"structure"`

	// The name of the index document for the website.
	IndexDocument *IndexDocument `type:"structure"`

	// The redirect behavior for every request to this bucket's website endpoint.
	//
	// If you specify this property, you can't specify any other property.
	RedirectAllRequestsTo *RedirectAllRequestsTo `type:"structure"`

	// Rules that define when a redirect is applied and the redirect behavior.
	RoutingRules []RoutingRule `locationNameList:"RoutingRule" type:"list"`
	// contains filtered or unexported fields
}

Specifies website configuration parameters for an Amazon S3 bucket.

func (WebsiteConfiguration) MarshalFields added in v0.3.0

func (s WebsiteConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WebsiteConfiguration) String

func (s WebsiteConfiguration) String() string

String returns the string representation

func (*WebsiteConfiguration) Validate

func (s *WebsiteConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

Directories

Path Synopsis
internal
arn
configtesting Module
Package s3iface provides an interface to enable mocking the Amazon Simple Storage Service service client for testing your code.
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.
Package s3manager provides utilities to upload and download objects from S3 concurrently.
s3manageriface
Package s3manageriface provides an interface for the s3manager package
Package s3manageriface provides an interface for the s3manager package

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL