Struct: s3.DeleteObjectsInput

import "../ibm-cos-sdk-go/service/s3"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary collapse

Bucket *string

The bucket name containing the objects to delete.
BypassGovernanceRetention *bool

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.
Delete *Delete

Container for the request.
ExpectedBucketOwner *string

Ignored by COS.
MFA *string

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
RequestPayer *string

Confirms that the requester knows that they will be charged for the request.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetBucket(string) *DeleteObjectsInput operation

SetBucket sets the Bucket field's value.
SetBypassGovernanceRetention(bool) *DeleteObjectsInput operation

SetBypassGovernanceRetention sets the BypassGovernanceRetention field's value.
SetDelete(*Delete) *DeleteObjectsInput operation

SetDelete sets the Delete field's value.
SetExpectedBucketOwner(string) *DeleteObjectsInput operation

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.
SetMFA(string) *DeleteObjectsInput operation

SetMFA sets the MFA field's value.
SetRequestPayer(string) *DeleteObjectsInput operation

SetRequestPayer sets the RequestPayer field's value.
String() string operation

String returns the string representation.
Validate() error operation

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

Structure Field Details

Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

The bucket name containing the objects to delete.

When using this action 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 action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points (docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? (docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

Bucket is a required field

BypassGovernanceRetention *bool `location:"header" locationName:"x-amz-bypass-governance-retention" type:"boolean"`

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.

Delete *Delete `locationName:"Delete" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

Container for the request.

Delete is a required field

ExpectedBucketOwner *string `location:"header" locationName:"x-amz-expected-bucket-owner" type:"string"`

Ignored by COS.

MFA *string `location:"header" locationName:"x-amz-mfa" type:"string"`

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.

RequestPayer *string `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"RequestPayer"`

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets (docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the Amazon S3 User Guide.

_ struct{} `locationName:"DeleteObjectsRequest" type:"structure" payload:"Delete"`

Method Details

func (s DeleteObjectsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.



11001
11002
11003

// File 'service/s3/api.go', line 11001

func (s DeleteObjectsInput) GoString() string {
	return s.String()
}

func (s DeleteObjectsInput) SetBucket(v string) DeleteObjectsInput

SetBucket sets the Bucket field's value.

// File 'service/s3/api.go', line 11030

func (s *DeleteObjectsInput) SetBucket(v string) *DeleteObjectsInput {
	s.Bucket = &v
	return s
}

func (s DeleteObjectsInput) SetBypassGovernanceRetention(v bool) DeleteObjectsInput

SetBypassGovernanceRetention sets the BypassGovernanceRetention field's value.

// File 'service/s3/api.go', line 11043

func (s *DeleteObjectsInput) SetBypassGovernanceRetention(v bool) *DeleteObjectsInput {
	s.BypassGovernanceRetention = &v
	return s
}

func (s DeleteObjectsInput) SetDelete(v Delete) *DeleteObjectsInput

SetDelete sets the Delete field's value.

// File 'service/s3/api.go', line 11049

func (s *DeleteObjectsInput) SetDelete(v *Delete) *DeleteObjectsInput {
	s.Delete = v
	return s
}

func (s DeleteObjectsInput) SetExpectedBucketOwner(v string) DeleteObjectsInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

// File 'service/s3/api.go', line 11055

func (s *DeleteObjectsInput) SetExpectedBucketOwner(v string) *DeleteObjectsInput {
	s.ExpectedBucketOwner = &v
	return s
}

func (s DeleteObjectsInput) SetMFA(v string) DeleteObjectsInput

SetMFA sets the MFA field's value.

// File 'service/s3/api.go', line 11061

func (s *DeleteObjectsInput) SetMFA(v string) *DeleteObjectsInput {
	s.MFA = &v
	return s
}

func (s DeleteObjectsInput) SetRequestPayer(v string) DeleteObjectsInput

SetRequestPayer sets the RequestPayer field's value.

// File 'service/s3/api.go', line 11067

func (s *DeleteObjectsInput) SetRequestPayer(v string) *DeleteObjectsInput {
	s.RequestPayer = &v
	return s
}

func (s DeleteObjectsInput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.



10992
10993
10994

// File 'service/s3/api.go', line 10992

func (s DeleteObjectsInput) String() string {
	return awsutil.Prettify(s)
}

func (s *DeleteObjectsInput) Validate() error

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

// File 'service/s3/api.go', line 11006

func (s *DeleteObjectsInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "DeleteObjectsInput"}
	if s.Bucket == nil {
		invalidParams.Add(request.NewErrParamRequired("Bucket"))
	}
	if s.Bucket != nil && len(*s.Bucket) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Bucket", 1))
	}
	if s.Delete == nil {
		invalidParams.Add(request.NewErrParamRequired("Delete"))
	}
	if s.Delete != nil {
		if err := s.Delete.Validate(); err != nil {
			invalidParams.AddNested("Delete", err.(request.ErrInvalidParams))
		}
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}