putObject method

Future<PutObjectResponse> putObject({required Uint8List body, required String path, String? cacheControl, String? contentType, StorageClass? storageClass, UploadAvailability? uploadAvailability})

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

May throw ContainerNotFoundException. May throw InternalServerError.

Parameter body : The bytes to be stored.

Parameter path : The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi.

Do not include the container name in this path.

If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

Parameter cacheControl : An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Headers with a custom user-defined value are also accepted.

Parameter contentType : The content type of the object.

Parameter storageClass : Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.

Parameter uploadAvailability : Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

Implementation

Future<PutObjectResponse> putObject({
  required Uint8List body,
  required String path,
  String? cacheControl,
  String? contentType,
  StorageClass? storageClass,
  UploadAvailability? uploadAvailability,
}) async {
  ArgumentError.checkNotNull(body, 'body');
  ArgumentError.checkNotNull(path, 'path');
  _s.validateStringLength(
    'path',
    path,
    1,
    900,
    isRequired: true,
  );
  final headers = <String, String>{
    if (cacheControl != null) 'Cache-Control': cacheControl.toString(),
    if (contentType != null) 'Content-Type': contentType.toString(),
    if (storageClass != null) 'x-amz-storage-class': storageClass.toValue(),
    if (uploadAvailability != null)
      'x-amz-upload-availability': uploadAvailability.toValue(),
  };
  final response = await _protocol.send(
    payload: body,
    method: 'PUT',
    requestUri: '/${path.split('/').map(Uri.encodeComponent).join('/')}',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return PutObjectResponse.fromJson(response);
}