Struct: s3.CreateMultipartUploadInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

ACL *string `location:"header" locationName:"x-amz-acl" type:"string" enum:"ObjectCannedACL"`

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

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

The name of the bucket to which to initiate the upload

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

CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

Specifies caching behavior along the request/reply chain.

ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

Specifies presentational information for the object.

ContentEncoding *string `location:"header" locationName:"Content-Encoding" 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.

ContentLanguage *string `location:"header" locationName:"Content-Language" type:"string"`

The language the content is in.

ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

A standard MIME type describing the format of the object data.

Expires *time.Time `location:"header" locationName:"Expires" type:"timestamp"`

The date and time at which the object is no longer cacheable.

GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

Object key for which the multipart upload is to be initiated.

Key is a required field

Metadata map[string]*string `location:"headers" locationName:"x-amz-meta-" type:"map"`

A map of metadata to store with the object in S3.

ObjectLockLegalHoldStatus *string `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"ObjectLockLegalHoldStatus"`

Specifies whether you want to apply a Legal Hold to the uploaded object.

ObjectLockMode *string `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"ObjectLockMode"`

Specifies the Object Lock mode that you want to apply to the uploaded object.

ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

Specifies the date and time when you want the Object Lock to expire.

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.

SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"`

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 is a sensitive parameter and its value will be replaced with “sensitive” in string returned by CreateMultipartUploadInput's String and GoString methods.

SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

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.

SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication (docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) in the Amazon S3 User Guide.

SSEKMSKeyId is a sensitive parameter and its value will be replaced with “sensitive” in string returned by CreateMultipartUploadInput's String and GoString methods.

ServerSideEncryption *string `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"ServerSideEncryption"`

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

StorageClass *string `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"StorageClass"`

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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes (docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the Amazon S3 User Guide.

Tagging *string `location:"header" locationName:"x-amz-tagging" type:"string"`

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" 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.

_ struct{} `locationName:"CreateMultipartUploadRequest" type:"structure"`

Method Details

func (s CreateMultipartUploadInput) 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”.



9454
9455
9456
 
// File 'service/s3/api.go', line 9454


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

func (s *CreateMultipartUploadInput) SetACL(v string) *CreateMultipartUploadInput

SetACL sets the ACL field's value.



9481
9482
9483
9484
 
// File 'service/s3/api.go', line 9481


func (s *CreateMultipartUploadInput) SetACL(v string) *CreateMultipartUploadInput {
	s.ACL = &v
	return s
}

func (s *CreateMultipartUploadInput) SetBucket(v string) *CreateMultipartUploadInput

SetBucket sets the Bucket field's value.



9487
9488
9489
9490
 
// File 'service/s3/api.go', line 9487


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

func (s *CreateMultipartUploadInput) SetCacheControl(v string) *CreateMultipartUploadInput

SetCacheControl sets the CacheControl field's value.



9500
9501
9502
9503
 
// File 'service/s3/api.go', line 9500


func (s *CreateMultipartUploadInput) SetCacheControl(v string) *CreateMultipartUploadInput {
	s.CacheControl = &v
	return s
}

func (s *CreateMultipartUploadInput) SetContentDisposition(v string) *CreateMultipartUploadInput

SetContentDisposition sets the ContentDisposition field's value.



9506
9507
9508
9509
 
// File 'service/s3/api.go', line 9506


func (s *CreateMultipartUploadInput) SetContentDisposition(v string) *CreateMultipartUploadInput {
	s.ContentDisposition = &v
	return s
}

func (s *CreateMultipartUploadInput) SetContentEncoding(v string) *CreateMultipartUploadInput

SetContentEncoding sets the ContentEncoding field's value.



9512
9513
9514
9515
 
// File 'service/s3/api.go', line 9512


func (s *CreateMultipartUploadInput) SetContentEncoding(v string) *CreateMultipartUploadInput {
	s.ContentEncoding = &v
	return s
}

func (s *CreateMultipartUploadInput) SetContentLanguage(v string) *CreateMultipartUploadInput

SetContentLanguage sets the ContentLanguage field's value.



9518
9519
9520
9521
 
// File 'service/s3/api.go', line 9518


func (s *CreateMultipartUploadInput) SetContentLanguage(v string) *CreateMultipartUploadInput {
	s.ContentLanguage = &v
	return s
}

func (s *CreateMultipartUploadInput) SetContentType(v string) *CreateMultipartUploadInput

SetContentType sets the ContentType field's value.



9524
9525
9526
9527
 
// File 'service/s3/api.go', line 9524


func (s *CreateMultipartUploadInput) SetContentType(v string) *CreateMultipartUploadInput {
	s.ContentType = &v
	return s
}

func (s *CreateMultipartUploadInput) SetExpires(v time.Time) *CreateMultipartUploadInput

SetExpires sets the Expires field's value.



9530
9531
9532
9533
 
// File 'service/s3/api.go', line 9530


func (s *CreateMultipartUploadInput) SetExpires(v time.Time) *CreateMultipartUploadInput {
	s.Expires = &v
	return s
}

func (s *CreateMultipartUploadInput) SetGrantFullControl(v string) *CreateMultipartUploadInput

SetGrantFullControl sets the GrantFullControl field's value.



9536
9537
9538
9539
 
// File 'service/s3/api.go', line 9536


func (s *CreateMultipartUploadInput) SetGrantFullControl(v string) *CreateMultipartUploadInput {
	s.GrantFullControl = &v
	return s
}

func (s *CreateMultipartUploadInput) SetGrantRead(v string) *CreateMultipartUploadInput

SetGrantRead sets the GrantRead field's value.



9542
9543
9544
9545
 
// File 'service/s3/api.go', line 9542


func (s *CreateMultipartUploadInput) SetGrantRead(v string) *CreateMultipartUploadInput {
	s.GrantRead = &v
	return s
}

func (s *CreateMultipartUploadInput) SetGrantReadACP(v string) *CreateMultipartUploadInput

SetGrantReadACP sets the GrantReadACP field's value.



9548
9549
9550
9551
 
// File 'service/s3/api.go', line 9548


func (s *CreateMultipartUploadInput) SetGrantReadACP(v string) *CreateMultipartUploadInput {
	s.GrantReadACP = &v
	return s
}

func (s *CreateMultipartUploadInput) SetGrantWriteACP(v string) *CreateMultipartUploadInput

SetGrantWriteACP sets the GrantWriteACP field's value.



9554
9555
9556
9557
 
// File 'service/s3/api.go', line 9554


func (s *CreateMultipartUploadInput) SetGrantWriteACP(v string) *CreateMultipartUploadInput {
	s.GrantWriteACP = &v
	return s
}

func (s *CreateMultipartUploadInput) SetKey(v string) *CreateMultipartUploadInput

SetKey sets the Key field's value.



9560
9561
9562
9563
 
// File 'service/s3/api.go', line 9560


func (s *CreateMultipartUploadInput) SetKey(v string) *CreateMultipartUploadInput {
	s.Key = &v
	return s
}

func (s *CreateMultipartUploadInput) SetMetadata(v map[string]*string) *CreateMultipartUploadInput

SetMetadata sets the Metadata field's value.



9566
9567
9568
9569
 
// File 'service/s3/api.go', line 9566


func (s *CreateMultipartUploadInput) SetMetadata(v map[string]*string) *CreateMultipartUploadInput {
	s.Metadata = v
	return s
}

func (s *CreateMultipartUploadInput) SetObjectLockLegalHoldStatus(v string) *CreateMultipartUploadInput

SetObjectLockLegalHoldStatus sets the ObjectLockLegalHoldStatus field's value.



9572
9573
9574
9575
 
// File 'service/s3/api.go', line 9572


func (s *CreateMultipartUploadInput) SetObjectLockLegalHoldStatus(v string) *CreateMultipartUploadInput {
	s.ObjectLockLegalHoldStatus = &v
	return s
}

func (s *CreateMultipartUploadInput) SetObjectLockMode(v string) *CreateMultipartUploadInput

SetObjectLockMode sets the ObjectLockMode field's value.



9578
9579
9580
9581
 
// File 'service/s3/api.go', line 9578


func (s *CreateMultipartUploadInput) SetObjectLockMode(v string) *CreateMultipartUploadInput {
	s.ObjectLockMode = &v
	return s
}

func (s *CreateMultipartUploadInput) SetObjectLockRetainUntilDate(v time.Time) *CreateMultipartUploadInput

SetObjectLockRetainUntilDate sets the ObjectLockRetainUntilDate field's value.



9584
9585
9586
9587
 
// File 'service/s3/api.go', line 9584


func (s *CreateMultipartUploadInput) SetObjectLockRetainUntilDate(v time.Time) *CreateMultipartUploadInput {
	s.ObjectLockRetainUntilDate = &v
	return s
}

func (s *CreateMultipartUploadInput) SetRequestPayer(v string) *CreateMultipartUploadInput

SetRequestPayer sets the RequestPayer field's value.



9590
9591
9592
9593
 
// File 'service/s3/api.go', line 9590


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

func (s *CreateMultipartUploadInput) SetServerSideEncryption(v string) *CreateMultipartUploadInput

SetServerSideEncryption sets the ServerSideEncryption field's value.



9627
9628
9629
9630
 
// File 'service/s3/api.go', line 9627


func (s *CreateMultipartUploadInput) SetServerSideEncryption(v string) *CreateMultipartUploadInput {
	s.ServerSideEncryption = &v
	return s
}

func (s *CreateMultipartUploadInput) SetSSECustomerAlgorithm(v string) *CreateMultipartUploadInput

SetSSECustomerAlgorithm sets the SSECustomerAlgorithm field's value.



9596
9597
9598
9599
 
// File 'service/s3/api.go', line 9596


func (s *CreateMultipartUploadInput) SetSSECustomerAlgorithm(v string) *CreateMultipartUploadInput {
	s.SSECustomerAlgorithm = &v
	return s
}

func (s *CreateMultipartUploadInput) SetSSECustomerKey(v string) *CreateMultipartUploadInput

SetSSECustomerKey sets the SSECustomerKey field's value.



9602
9603
9604
9605
 
// File 'service/s3/api.go', line 9602


func (s *CreateMultipartUploadInput) SetSSECustomerKey(v string) *CreateMultipartUploadInput {
	s.SSECustomerKey = &v
	return s
}

func (s *CreateMultipartUploadInput) SetSSECustomerKeyMD5(v string) *CreateMultipartUploadInput

SetSSECustomerKeyMD5 sets the SSECustomerKeyMD5 field's value.



9615
9616
9617
9618
 
// File 'service/s3/api.go', line 9615


func (s *CreateMultipartUploadInput) SetSSECustomerKeyMD5(v string) *CreateMultipartUploadInput {
	s.SSECustomerKeyMD5 = &v
	return s
}

func (s *CreateMultipartUploadInput) SetSSEKMSKeyId(v string) *CreateMultipartUploadInput

SetSSEKMSKeyId sets the SSEKMSKeyId field's value.



9621
9622
9623
9624
 
// File 'service/s3/api.go', line 9621


func (s *CreateMultipartUploadInput) SetSSEKMSKeyId(v string) *CreateMultipartUploadInput {
	s.SSEKMSKeyId = &v
	return s
}

func (s *CreateMultipartUploadInput) SetStorageClass(v string) *CreateMultipartUploadInput

SetStorageClass sets the StorageClass field's value.



9633
9634
9635
9636
 
// File 'service/s3/api.go', line 9633


func (s *CreateMultipartUploadInput) SetStorageClass(v string) *CreateMultipartUploadInput {
	s.StorageClass = &v
	return s
}

func (s *CreateMultipartUploadInput) SetTagging(v string) *CreateMultipartUploadInput

SetTagging sets the Tagging field's value.



9639
9640
9641
9642
 
// File 'service/s3/api.go', line 9639


func (s *CreateMultipartUploadInput) SetTagging(v string) *CreateMultipartUploadInput {
	s.Tagging = &v
	return s
}

func (s *CreateMultipartUploadInput) SetWebsiteRedirectLocation(v string) *CreateMultipartUploadInput

SetWebsiteRedirectLocation sets the WebsiteRedirectLocation field's value.



9645
9646
9647
9648
 
// File 'service/s3/api.go', line 9645


func (s *CreateMultipartUploadInput) SetWebsiteRedirectLocation(v string) *CreateMultipartUploadInput {
	s.WebsiteRedirectLocation = &v
	return s
}

func (s CreateMultipartUploadInput) 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”.



9445
9446
9447
 
// File 'service/s3/api.go', line 9445


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

func (s *CreateMultipartUploadInput) Validate() error

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



9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
// File 'service/s3/api.go', line 9459


func (s *CreateMultipartUploadInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "CreateMultipartUploadInput"}
	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.Key == nil {
		invalidParams.Add(request.NewErrParamRequired("Key"))
	}
	if s.Key != nil && len(*s.Key) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Key", 1))
	}

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