NAME
Paws::S3 - Perl Interface to AWS Amazon Simple Storage Service
SYNOPSIS
use Paws;
my $obj = Paws->service('S3');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);
DESCRIPTION
Amazon Simple Storage Service
Amazon Simple Storage Service is storage for the Internet. It is designed to make web-scale computing easier for developers.
Amazon S3 has a simple web services interface that you can use to store and retrieve any amount of data, at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service aims to maximize benefits of scale and to pass those benefits on to developers.
METHODS
AbortMultipartUpload(Bucket => Str, Key => Str, UploadId => Str, [RequestPayer => Str])
Each argument is described in detail in: Paws::S3::AbortMultipartUpload
Returns: a Paws::S3::AbortMultipartUploadOutput instance
Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.
CompleteMultipartUpload(Bucket => Str, Key => Str, UploadId => Str, [MultipartUpload => Paws::S3::CompletedMultipartUpload, RequestPayer => Str])
Each argument is described in detail in: Paws::S3::CompleteMultipartUpload
Returns: a Paws::S3::CompleteMultipartUploadOutput instance
Completes a multipart upload by assembling previously uploaded parts.
CopyObject(Bucket => Str, CopySource => Str, Key => Str, [ACL => Str, CacheControl => Str, ContentDisposition => Str, ContentEncoding => Str, ContentLanguage => Str, ContentType => Str, CopySourceIfMatch => Str, CopySourceIfModifiedSince => Str, CopySourceIfNoneMatch => Str, CopySourceIfUnmodifiedSince => Str, CopySourceSSECustomerAlgorithm => Str, CopySourceSSECustomerKey => Str, CopySourceSSECustomerKeyMD5 => Str, Expires => Str, GrantFullControl => Str, GrantRead => Str, GrantReadACP => Str, GrantWriteACP => Str, Metadata => Paws::S3::Metadata, MetadataDirective => Str, RequestPayer => Str, ServerSideEncryption => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str, SSEKMSKeyId => Str, StorageClass => Str, WebsiteRedirectLocation => Str])
Each argument is described in detail in: Paws::S3::CopyObject
Returns: a Paws::S3::CopyObjectOutput instance
Creates a copy of an object that is already stored in Amazon S3.
CreateBucket(Bucket => Str, [ACL => Str, CreateBucketConfiguration => Paws::S3::CreateBucketConfiguration, GrantFullControl => Str, GrantRead => Str, GrantReadACP => Str, GrantWrite => Str, GrantWriteACP => Str])
Each argument is described in detail in: Paws::S3::CreateBucket
Returns: a Paws::S3::CreateBucketOutput instance
Creates a new bucket.
CreateMultipartUpload(Bucket => Str, Key => Str, [ACL => Str, CacheControl => Str, ContentDisposition => Str, ContentEncoding => Str, ContentLanguage => Str, ContentType => Str, Expires => Str, GrantFullControl => Str, GrantRead => Str, GrantReadACP => Str, GrantWriteACP => Str, Metadata => Paws::S3::Metadata, RequestPayer => Str, ServerSideEncryption => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str, SSEKMSKeyId => Str, StorageClass => Str, WebsiteRedirectLocation => Str])
Each argument is described in detail in: Paws::S3::CreateMultipartUpload
Returns: a Paws::S3::CreateMultipartUploadOutput instance
Initiates a multipart upload and returns an upload ID.
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.
DeleteBucket(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucket
Returns: nothing
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.
DeleteBucketCors(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucketCors
Returns: nothing
Deletes the cors configuration information set for the bucket.
DeleteBucketLifecycle(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucketLifecycle
Returns: nothing
Deletes the lifecycle configuration from the bucket.
DeleteBucketPolicy(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucketPolicy
Returns: nothing
Deletes the policy from the bucket.
DeleteBucketReplication(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucketReplication
Returns: nothing
Deletes the replication configuration from the bucket.
DeleteBucketTagging(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucketTagging
Returns: nothing
Deletes the tags from the bucket.
DeleteBucketWebsite(Bucket => Str)
Each argument is described in detail in: Paws::S3::DeleteBucketWebsite
Returns: nothing
This operation removes the website configuration from the bucket.
DeleteObject(Bucket => Str, Key => Str, [MFA => Str, RequestPayer => Str, VersionId => Str])
Each argument is described in detail in: Paws::S3::DeleteObject
Returns: a Paws::S3::DeleteObjectOutput instance
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.
DeleteObjects(Bucket => Str, Delete => Paws::S3::Delete, [MFA => Str, RequestPayer => Str])
Each argument is described in detail in: Paws::S3::DeleteObjects
Returns: a Paws::S3::DeleteObjectsOutput instance
This operation enables you to delete multiple objects from a bucket
using a single HTTP request. You may specify up to 1000 keys.
GetBucketAcl(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketAcl
Returns: a Paws::S3::GetBucketAclOutput instance
Gets the access control policy for the bucket.
GetBucketCors(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketCors
Returns: a Paws::S3::GetBucketCorsOutput instance
Returns the cors configuration for the bucket.
GetBucketLifecycle(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketLifecycle
Returns: a Paws::S3::GetBucketLifecycleOutput instance
Deprecated, see the GetBucketLifecycleConfiguration operation.
GetBucketLifecycleConfiguration(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketLifecycleConfiguration
Returns: a Paws::S3::GetBucketLifecycleConfigurationOutput instance
Returns the lifecycle configuration information set on the bucket.
GetBucketLocation(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketLocation
Returns: a Paws::S3::GetBucketLocationOutput instance
Returns the region the bucket resides in.
GetBucketLogging(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketLogging
Returns: a Paws::S3::GetBucketLoggingOutput instance
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.
GetBucketNotification(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketNotification
Returns: a Paws::S3::NotificationConfigurationDeprecated instance
Deprecated, see the GetBucketNotificationConfiguration operation.
GetBucketNotificationConfiguration(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketNotificationConfiguration
Returns: a Paws::S3::NotificationConfiguration instance
Returns the notification configuration of a bucket.
GetBucketPolicy(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketPolicy
Returns: a Paws::S3::GetBucketPolicyOutput instance
Returns the policy of a specified bucket.
GetBucketReplication(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketReplication
Returns: a Paws::S3::GetBucketReplicationOutput instance
Deprecated, see the GetBucketReplicationConfiguration operation.
GetBucketRequestPayment(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketRequestPayment
Returns: a Paws::S3::GetBucketRequestPaymentOutput instance
Returns the request payment configuration of a bucket.
GetBucketTagging(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketTagging
Returns: a Paws::S3::GetBucketTaggingOutput instance
Returns the tag set associated with the bucket.
GetBucketVersioning(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketVersioning
Returns: a Paws::S3::GetBucketVersioningOutput instance
Returns the versioning state of a bucket.
GetBucketWebsite(Bucket => Str)
Each argument is described in detail in: Paws::S3::GetBucketWebsite
Returns: a Paws::S3::GetBucketWebsiteOutput instance
Returns the website configuration for a bucket.
GetObject(Bucket => Str, Key => Str, [IfMatch => Str, IfModifiedSince => Str, IfNoneMatch => Str, IfUnmodifiedSince => Str, Range => Str, RequestPayer => Str, ResponseCacheControl => Str, ResponseContentDisposition => Str, ResponseContentEncoding => Str, ResponseContentLanguage => Str, ResponseContentType => Str, ResponseExpires => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str, VersionId => Str])
Each argument is described in detail in: Paws::S3::GetObject
Returns: a Paws::S3::GetObjectOutput instance
Retrieves objects from Amazon S3.
GetObjectAcl(Bucket => Str, Key => Str, [RequestPayer => Str, VersionId => Str])
Each argument is described in detail in: Paws::S3::GetObjectAcl
Returns: a Paws::S3::GetObjectAclOutput instance
Returns the access control list (ACL) of an object.
GetObjectTorrent(Bucket => Str, Key => Str, [RequestPayer => Str])
Each argument is described in detail in: Paws::S3::GetObjectTorrent
Returns: a Paws::S3::GetObjectTorrentOutput instance
Return torrent files from a bucket.
HeadBucket(Bucket => Str)
Each argument is described in detail in: Paws::S3::HeadBucket
Returns: nothing
This operation is useful to determine if a bucket exists and you have
permission to access it.
HeadObject(Bucket => Str, Key => Str, [IfMatch => Str, IfModifiedSince => Str, IfNoneMatch => Str, IfUnmodifiedSince => Str, Range => Str, RequestPayer => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str, VersionId => Str])
Each argument is described in detail in: Paws::S3::HeadObject
Returns: a Paws::S3::HeadObjectOutput instance
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.
ListBuckets( => )
Each argument is described in detail in: Paws::S3::ListBuckets
Returns: a Paws::S3::ListBucketsOutput instance
Returns a list of all buckets owned by the authenticated sender of the
request.
ListMultipartUploads(Bucket => Str, [Delimiter => Str, EncodingType => Str, KeyMarker => Str, MaxUploads => Int, Prefix => Str, UploadIdMarker => Str])
Each argument is described in detail in: Paws::S3::ListMultipartUploads
Returns: a Paws::S3::ListMultipartUploadsOutput instance
This operation lists in-progress multipart uploads.
ListObjects(Bucket => Str, [Delimiter => Str, EncodingType => Str, Marker => Str, MaxKeys => Int, Prefix => Str])
Each argument is described in detail in: Paws::S3::ListObjects
Returns: a Paws::S3::ListObjectsOutput instance
Returns some or all (up to 1000) 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.
ListObjectVersions(Bucket => Str, [Delimiter => Str, EncodingType => Str, KeyMarker => Str, MaxKeys => Int, Prefix => Str, VersionIdMarker => Str])
Each argument is described in detail in: Paws::S3::ListObjectVersions
Returns: a Paws::S3::ListObjectVersionsOutput instance
Returns metadata about all of the versions of objects in a bucket.
ListParts(Bucket => Str, Key => Str, UploadId => Str, [MaxParts => Int, PartNumberMarker => Int, RequestPayer => Str])
Each argument is described in detail in: Paws::S3::ListParts
Returns: a Paws::S3::ListPartsOutput instance
Lists the parts that have been uploaded for a specific multipart
upload.
PutBucketAcl(Bucket => Str, [AccessControlPolicy => Paws::S3::AccessControlPolicy, ACL => Str, ContentMD5 => Str, GrantFullControl => Str, GrantRead => Str, GrantReadACP => Str, GrantWrite => Str, GrantWriteACP => Str])
Each argument is described in detail in: Paws::S3::PutBucketAcl
Returns: nothing
Sets the permissions on a bucket using access control lists (ACL).
PutBucketCors(Bucket => Str, CORSConfiguration => Paws::S3::CORSConfiguration, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketCors
Returns: nothing
Sets the cors configuration for a bucket.
PutBucketLifecycle(Bucket => Str, [ContentMD5 => Str, LifecycleConfiguration => Paws::S3::LifecycleConfiguration])
Each argument is described in detail in: Paws::S3::PutBucketLifecycle
Returns: nothing
Deprecated, see the PutBucketLifecycleConfiguration operation.
PutBucketLifecycleConfiguration(Bucket => Str, [LifecycleConfiguration => Paws::S3::BucketLifecycleConfiguration])
Each argument is described in detail in: Paws::S3::PutBucketLifecycleConfiguration
Returns: nothing
Sets lifecycle configuration for your bucket. If a lifecycle
configuration exists, it replaces it.
PutBucketLogging(Bucket => Str, BucketLoggingStatus => Paws::S3::BucketLoggingStatus, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketLogging
Returns: nothing
Set the logging parameters for a bucket and to specify permissions for
who can view and modify the logging parameters. To set the logging
status of a bucket, you must be the bucket owner.
PutBucketNotification(Bucket => Str, NotificationConfiguration => Paws::S3::NotificationConfigurationDeprecated, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketNotification
Returns: nothing
Deprecated, see the PutBucketNotificationConfiguraiton operation.
PutBucketNotificationConfiguration(Bucket => Str, NotificationConfiguration => Paws::S3::NotificationConfiguration)
Each argument is described in detail in: Paws::S3::PutBucketNotificationConfiguration
Returns: nothing
Enables notifications of specified events for a bucket.
PutBucketPolicy(Bucket => Str, Policy => Str, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketPolicy
Returns: nothing
Replaces a policy on a bucket. If the bucket already has a policy, the
one in this request completely replaces it.
PutBucketReplication(Bucket => Str, ReplicationConfiguration => Paws::S3::ReplicationConfiguration, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketReplication
Returns: nothing
Creates a new replication configuration (or replaces an existing one,
if present).
PutBucketRequestPayment(Bucket => Str, RequestPaymentConfiguration => Paws::S3::RequestPaymentConfiguration, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketRequestPayment
Returns: nothing
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. Documentation
on requester pays buckets can be found at
http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
PutBucketTagging(Bucket => Str, Tagging => Paws::S3::Tagging, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketTagging
Returns: nothing
Sets the tags for a bucket.
PutBucketVersioning(Bucket => Str, VersioningConfiguration => Paws::S3::VersioningConfiguration, [ContentMD5 => Str, MFA => Str])
Each argument is described in detail in: Paws::S3::PutBucketVersioning
Returns: nothing
Sets the versioning state of an existing bucket. To set the versioning
state, you must be the bucket owner.
PutBucketWebsite(Bucket => Str, WebsiteConfiguration => Paws::S3::WebsiteConfiguration, [ContentMD5 => Str])
Each argument is described in detail in: Paws::S3::PutBucketWebsite
Returns: nothing
Set the website configuration for a bucket.
PutObject(Bucket => Str, Key => Str, [ACL => Str, Body => Str, CacheControl => Str, ContentDisposition => Str, ContentEncoding => Str, ContentLanguage => Str, ContentLength => Int, ContentMD5 => Str, ContentType => Str, Expires => Str, GrantFullControl => Str, GrantRead => Str, GrantReadACP => Str, GrantWriteACP => Str, Metadata => Paws::S3::Metadata, RequestPayer => Str, ServerSideEncryption => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str, SSEKMSKeyId => Str, StorageClass => Str, WebsiteRedirectLocation => Str])
Each argument is described in detail in: Paws::S3::PutObject
Returns: a Paws::S3::PutObjectOutput instance
Adds an object to a bucket.
PutObjectAcl(Bucket => Str, Key => Str, [AccessControlPolicy => Paws::S3::AccessControlPolicy, ACL => Str, ContentMD5 => Str, GrantFullControl => Str, GrantRead => Str, GrantReadACP => Str, GrantWrite => Str, GrantWriteACP => Str, RequestPayer => Str, VersionId => Str])
Each argument is described in detail in: Paws::S3::PutObjectAcl
Returns: a Paws::S3::PutObjectAclOutput instance
uses the acl subresource to set the access control list (ACL)
permissions for an object that already exists in a bucket
RestoreObject(Bucket => Str, Key => Str, [RequestPayer => Str, RestoreRequest => Paws::S3::RestoreRequest, VersionId => Str])
Each argument is described in detail in: Paws::S3::RestoreObject
Returns: a Paws::S3::RestoreObjectOutput instance
Restores an archived copy of an object back into Amazon S3
UploadPart(Bucket => Str, Key => Str, PartNumber => Int, UploadId => Str, [Body => Str, ContentLength => Int, ContentMD5 => Str, RequestPayer => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str])
Each argument is described in detail in: Paws::S3::UploadPart
Returns: a Paws::S3::UploadPartOutput instance
Uploads a part in a multipart upload.
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.
UploadPartCopy(Bucket => Str, CopySource => Str, Key => Str, PartNumber => Int, UploadId => Str, [CopySourceIfMatch => Str, CopySourceIfModifiedSince => Str, CopySourceIfNoneMatch => Str, CopySourceIfUnmodifiedSince => Str, CopySourceRange => Str, CopySourceSSECustomerAlgorithm => Str, CopySourceSSECustomerKey => Str, CopySourceSSECustomerKeyMD5 => Str, RequestPayer => Str, SSECustomerAlgorithm => Str, SSECustomerKey => Str, SSECustomerKeyMD5 => Str])
Each argument is described in detail in: Paws::S3::UploadPartCopy
Returns: a Paws::S3::UploadPartCopyOutput instance
Uploads a part by copying data from an existing object as data source.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues