pdk.s3

contains structures to operate with S3 service

Bucket

Represents an Amazon S3 bucket.

Every object stored in Amazon S3 is contained within a bucket. Buckets partition the namespace of objects stored in Amazon S3 at the top level. Within a bucket, any name can be used for objects. However, bucket names must be unique across all of Amazon S3.

Bucket ownership is similar to the ownership of Internet domain names. Within Amazon S3, only a single user owns each bucket. Once a uniquely named bucket is created in Amazon S3, organize and name the objects within the bucket in any way. Ownership of the bucket is retained as long as the owner has an Amazon S3 account.

To conform with DNS requirements, the following constraints apply:

  • Bucket names should not contain underscores

  • Bucket names should be between 3 and 63 characters long

  • Bucket names should not end with a dash

  • Bucket names cannot contain adjacent periods

  • Bucket names cannot contain dashes next to periods (e.g., "my-.bucket.com" and "my.-bucket" are invalid)

  • Bucket names cannot contain uppercase characters

There are no limits to the number of objects that can be stored in a bucket. Performance does not vary based on the number of buckets used. Store all objects within a single bucket or organize them across several buckets.

Properties:

Superstructures: Object <- Any

CopyObjectResult

Contains the data returned by Amazon S3 from the copyObject call. This result may be ignored if not needed; otherwise, use this result to access information about the new object created from the copyObject call.

Properties:

  • checksumCRC32 :: pdk.core.String - The base64-encoded, 32-bit CRC32 checksum of the object.

  • checksumCRC32C :: pdk.core.String - The base64-encoded, 32-bit CRC32C checksum of the object.

  • checksumSHA1 :: pdk.core.String - The base64-encoded, 160-bit SHA-1 digest of the object.

  • checksumSHA256 :: pdk.core.String - The base64-encoded, 256-bit SHA-256 digest of the object.

  • eTag :: pdk.core.String - Returns the ETag of the new object.

  • lastModified :: pdk.core.Date - Creation date of the object.

Superstructures: Object <- Any

ListObjectsV2Response

Contains the data returned by Amazon S3 from the listObjectsV2 call.

Properties:

  • commonPrefixes :: pdk.core.Array<pdk.core.String> - All of the keys (up to 1,000) that share the same prefix are grouped together.

  • contents :: pdk.core.Array<pdk.s3.S3Object> - Metadata about each object returned.

  • hasCommonPrefixes :: pdk.core.Boolean - For responses, this returns true if the service returned a value for the CommonPrefixes property.

  • hasContents :: pdk.core.Boolean - For responses, this returns true if the service returned a value for the Contents property.

  • isTruncated :: pdk.core.Boolean - Set to false if all of the results were returned.

  • keyCount :: pdk.core.Integer - KeyCount is the number of keys returned with this request.

  • name :: pdk.core.String - The bucket name.

  • nextContinuationToken :: pdk.core.String - NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed.

Superstructures: Object <- Any

Owner

Container for the owner's display name and ID.

Properties:

Superstructures: Object <- Any

PutObjectResponse

Contains the data returned by Amazon S3 from the putObject call.

Properties:

  • bucketKeyEnabled :: pdk.core.Boolean - Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • checksumCRC32 :: pdk.core.String - The base64-encoded, 32-bit CRC32 checksum of the object.

  • checksumCRC32C :: pdk.core.String - The base64-encoded, 32-bit CRC32C checksum of the object.

  • checksumSHA1 :: pdk.core.String - The base64-encoded, 160-bit SHA-1 digest of the object.

  • checksumSHA256 :: pdk.core.String - The base64-encoded, 256-bit SHA-256 digest of the object.

  • eTag :: pdk.core.String - Entity tag for the uploaded object.

  • expiration :: pdk.core.String - If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header.

  • serverSideEncryptionAsString :: pdk.core.String - Returns the value of the RequestCharged property for this object.

  • sseCustomerAlgorithm :: pdk.core.String - If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

  • sseCustomerKeyMD5 :: pdk.core.String - If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

  • ssekmsEncryptionContext :: pdk.core.String - If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.

  • ssekmsKeyId :: pdk.core.String - f x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • versionId :: pdk.core.String - Version ID of the object.

Superstructures: Object <- Any

RestoreStatus

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

Properties:

  • isRestoreInProgress :: pdk.core.Boolean - Specifies whether the object is currently being restored.

  • restoreExpiryDate :: pdk.core.Date - Indicates when the restored copy will expire.

Superstructures: Object <- Any

S3Object

An object consists of data and its descriptive metadata.

Properties:

Superstructures: Object <- Any

Previouspdk.net.xmlNextpdk.sql

Last updated