aws_erin v0.4.2 AwsErin.S3 View Source

Documentation for S3.

Link to this section Summary

Link to this section Functions

Link to this function

delete_object(request, options \\ [])

View Source
delete_object(
  %AwsErin.S3.DeleteObject.Request{
    bucket: term(),
    key: term(),
    version_id: term(),
    x_amz_bypass_governance_retention: term(),
    x_amz_mfa: term(),
    x_amz_request_payer: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.S3.DeleteObject.Response{
     x_amz_delete_marker: term(),
     x_amz_request_charged: term(),
     x_amz_version_id: term()
   }}
  | {:error,
     %AwsErin.S3.Error{message: term(), raw: term(), request_id: term()}}

DeleteObject.

Link to this function

delete_objects(request, options \\ [])

View Source
delete_objects(
  %AwsErin.S3.DeleteObjects.Request{
    bucket: term(),
    delete_objects: term(),
    x_amz_bypass_governance_retention: term(),
    x_amz_mfa: term(),
    x_amz_request_payer: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.S3.DeleteObjects.Response{
     delete_result: term(),
     x_amz_request_charged: term()
   }}
  | {:error,
     %AwsErin.S3.Error{message: term(), raw: term(), request_id: term()}}

DeleteObjects.

Link to this function

get_object(request, options \\ [])

View Source
get_object(
  %AwsErin.S3.GetObject.Request{
    bucket: term(),
    if_match: term(),
    if_modified_since: term(),
    if_none_match: term(),
    if_unmodified_since: term(),
    key: term(),
    part_number: term(),
    range: term(),
    response_cache_control: term(),
    response_content_disposition: term(),
    response_content_encoding: term(),
    response_content_language: term(),
    response_content_type: term(),
    response_expires: term(),
    version_id: term(),
    x_amz_request_payer: term(),
    x_amz_server_side_encryption_customer_algorithm: term(),
    x_amz_server_side_encryption_customer_key: term(),
    x_amz_server_side_encryption_customer_key_md5: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.S3.GetObject.Response{
     accept_ranges: term(),
     body: term(),
     cache_control: term(),
     content_disposition: term(),
     content_encoding: term(),
     content_language: term(),
     content_length: term(),
     content_range: term(),
     content_type: term(),
     e_tag: term(),
     expires: term(),
     last_modified: term(),
     x_amz_delete_marker: term(),
     x_amz_expiration: term(),
     x_amz_missing_meta: term(),
     x_amz_mp_parts_count: term(),
     x_amz_object_lock_legal_hold: term(),
     x_amz_object_lock_mode: term(),
     x_amz_object_lock_retain_until_date: term(),
     x_amz_replication_status: term(),
     x_amz_request_charged: term(),
     x_amz_restore: term(),
     x_amz_server_side_encryption: term(),
     x_amz_server_side_encryption_aws_kms_key_id: term(),
     x_amz_server_side_encryption_customer_algorithm: term(),
     x_amz_server_side_encryption_customer_key_md5: term(),
     x_amz_storage_class: term(),
     x_amz_tagging_count: term(),
     x_amz_version_id: term(),
     x_amz_website_redirect_location: term()
   }}
  | {:error,
     %AwsErin.S3.Error{message: term(), raw: term(), request_id: term()}}

GetObject.

Link to this function

list_objects(request, options \\ [])

View Source
list_objects(
  %AwsErin.S3.ListObjects.Request{
    bucket: term(),
    continuation_token: term(),
    delimiter: term(),
    encoding_type: term(),
    fetch_owner: term(),
    max_keys: term(),
    prefix: term(),
    start_after: term(),
    type: term(),
    x_amz_request_payer: term()
  },
  keyword()
) ::
  {:ok, %AwsErin.S3.ListObjects.Response{list_bucket_result: term()}}
  | {:error,
     %AwsErin.S3.Error{message: term(), raw: term(), request_id: term()}}

ListObjects.

Link to this function

put_object(request, options \\ [])

View Source
put_object(
  %AwsErin.S3.PutObject.Request{
    body: term(),
    bucket: term(),
    cache_control: term(),
    content_disposition: term(),
    content_encoding: term(),
    content_language: term(),
    content_length: term(),
    content_md5: term(),
    content_type: term(),
    expires: term(),
    key: term(),
    x_amz_acl: term(),
    x_amz_grant_full_control: term(),
    x_amz_grant_read: term(),
    x_amz_grant_read_acp: term(),
    x_amz_grant_write_acp: term(),
    x_amz_object_lock_legal_hold: term(),
    x_amz_object_lock_mode: term(),
    x_amz_object_lock_retain_until_date: term(),
    x_amz_request_payer: term(),
    x_amz_server_side_encryption: term(),
    x_amz_server_side_encryption_aws_kms_key_id: term(),
    x_amz_server_side_encryption_context: term(),
    x_amz_server_side_encryption_customer_algorithm: term(),
    x_amz_server_side_encryption_customer_key: term(),
    x_amz_server_side_encryption_customer_key_md5: term(),
    x_amz_storage_class: term(),
    x_amz_tagging: term(),
    x_amz_website_redirect_location: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.S3.PutObject.Response{
     e_tag: term(),
     x_amz_expiration: term(),
     x_amz_request_charged: term(),
     x_amz_server_side_encryption: term(),
     x_amz_server_side_encryption_aws_kms_key_id: term(),
     x_amz_server_side_encryption_context: term(),
     x_amz_server_side_encryption_customer_algorithm: term(),
     x_amz_server_side_encryption_customer_key_md5: term(),
     x_amz_version_id: term()
   }}
  | {:error,
     %AwsErin.S3.Error{message: term(), raw: term(), request_id: term()}}

PutObject.