Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2014-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   *
   *  http://aws.amazon.com/apache2.0
   *
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.s3.model;
 
 import java.io.File;

Uploads a new object to the specified Amazon S3 bucket. The PutObjectRequest optionally uploads object metadata and applies a canned access control policy to the new object.

Amazon S3 never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.

Depending on whether a file or input stream is being uploaded, this request has slightly different behavior.

When uploading a file:

  • The client automatically computes a checksum of the file. Amazon S3 uses checksums to validate the data in each file.
  • Using the file extension, Amazon S3 attempts to determine the correct content type and content disposition to use for the object.

When uploading directly from an input stream, content length must be specified before data can be uploaded to Amazon S3. If not provided, the library will have to buffer the contents of the input stream in order to calculate it. Amazon S3 explicitly requires that the content length be sent in the request headers before any of the data is sent.

Amazon S3 is a distributed system. If Amazon S3 receives multiple write requests for the same object nearly simultaneously, all of the objects might be stored. However, only one object will obtain the key.

Note: Amazon S3 does not provide object locking; if this is needed, make sure to build it into the application layer.

If the caller specifies a location constraint when creating a bucket, all objects added to the bucket are stored in the same region as the bucket. For example, if specifying a Europe (EU) region constraint for a bucket, all of that bucket's objects are stored in the EU region.

The specified bucket must already exist and the caller must have Permission.Write permission to the bucket to upload an object.

If you are uploading or accessing KMS-encrypted objects, you need to specify the correct region of the bucket on your client and configure AWS Signature Version 4 for added security. For more information on how to do this, see http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify -signature-version

 
 public class PutObjectRequest extends AbstractPutObjectRequest {

    
Constructs a new PutObjectRequest object to upload a file to the specified bucket and key. After constructing the request, users may optionally specify object metadata or a canned ACL as well.

Parameters:
bucketName The name of an existing bucket to which the new object will be uploaded.
key The key under which to store the new object.
file The path of the file to upload to Amazon S3.
 
    public PutObjectRequest(String bucketNameString keyFile file) {
        super(bucketNamekeyfile);
    }

    
Constructs a new PutObjectRequest object to perform a redirect for the specified bucket and key. After constructing the request, users may optionally specify object metadata or a canned ACL as well.

The redirect is performed using the com.amazonaws.services.s3.Headers.REDIRECT_LOCATION header.

Parameters:
bucketName The name of an existing bucket to which the new object will be uploaded.
key The key under which to store the new object.
redirectLocation Sets the com.amazonaws.services.s3.Headers.REDIRECT_LOCATION header for the new object.
    public PutObjectRequest(String bucketNameString keyString redirectLocation) {
        super(bucketNamekeyredirectLocation);
    }

    
Constructs a new PutObjectRequest object to upload a stream of data to the specified bucket and key. After constructing the request, users may optionally specify object metadata or a canned ACL as well.

Content length for the data stream must be specified in the object metadata parameter; Amazon S3 requires it be passed in before the data is uploaded. Failure to specify a content length will cause the entire contents of the input stream to be buffered locally in memory so that the content length can be calculated, which can result in negative performance problems.

Parameters:
bucketName The name of an existing bucket to which the new object will be uploaded.
key The key under which to store the new object.
input The stream of data to upload to Amazon S3.
metadata The object metadata. At minimum this specifies the content length for the stream of data being uploaded.
    public PutObjectRequest(String bucketNameString keyInputStream input,
            ObjectMetadata metadata) {
        super(bucketNamekeyinputmetadata);
    }

    
Returns a clone (as deep as possible) of this request object.
    @Override
    public PutObjectRequest clone() {
        return this.copyPutObjectBaseTo(new PutObjectRequest(
            getBucketName(), getKey(), getFile()));
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest withBucketName(String bucketName) {
        return super.withBucketName(bucketName);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest withKey(String key) {
        return super.withKey(key);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest withStorageClass(String storageClass) {
        return super.withStorageClass(storageClass);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest withStorageClass(StorageClass storageClass) {
        return super.withStorageClass(storageClass);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest  withFile(File file) {
        return super.withFile(file);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest withMetadata(ObjectMetadata metadata) {
        return super.withMetadata(metadata);
    }
    @Override
    @SuppressWarnings("unchecked")
        return super.withCannedAcl(cannedAcl);
    }
    @Override
    @SuppressWarnings("unchecked")
            AccessControlList accessControlList) {
        return super.withAccessControlList(accessControlList);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest  withInputStream(InputStream inputStream) {
        return super.withInputStream(inputStream);
    }
    @Override
    @SuppressWarnings("unchecked")
    public PutObjectRequest withRedirectLocation(String redirectLocation) {
        return super.withRedirectLocation(redirectLocation);
    }
    @Override
    @SuppressWarnings("unchecked")
        return super.withSSECustomerKey(sseKey);
    }
    @Deprecated
    @Override
    @SuppressWarnings("unchecked")
            com.amazonaws.services.s3.model.ProgressListener progressListener) {
        return super.withProgressListener(progressListener);
    }
    @Override
    @SuppressWarnings("unchecked")
            SSEAwsKeyManagementParams sseAwsKeyManagementParams) {
        return super.withSSEAwsKeyManagementParams(sseAwsKeyManagementParams);
    }
New to GrepCode? Check out our FAQ X