S3Input: Metadata of data objects stored in S3.

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

Metadata of data objects stored in S3.

Description

Two options are provided: specifying a S3 prefix or by explicitly listing the files in manifest file and referencing the manifest file's S3 path.

Super class

sagemaker.core::ApiObject -> S3Input

Methods

Public methods

• S3Input$new()

• S3Input$clone()

Inherited methods

• sagemaker.core::ApiObject$format()
• sagemaker.core::ApiObject$from_paws()
• sagemaker.core::ApiObject$to_paws()

---

Method new()

Initialize S3Input.

Usage

S3Input$new(
  s3_uri = NULL,
  local_path = NULL,
  s3_data_type = "S3Prefix",
  s3_input_mode = "File",
  s3_data_distribution_type = "FullyReplicated",
  s3_compression_type = NULL
)

Arguments

s3_uri

(str, default=None): the path to a specific S3 object or a S3 prefix

local_path

(str, default=None): the path to a local directory. If not provided, skips data download by SageMaker platform.

s3_data_type

(str, default="S3Prefix"): Valid options are "ManifestFile" or "S3Prefix".

s3_input_mode

(str, default="File"): Valid options are "Pipe" or "File".

s3_data_distribution_type

(str, default="FullyReplicated"): Valid options are "FullyReplicated" or "ShardedByS3Key".

s3_compression_type

(str, default=None): Valid options are "None" or "Gzip"

---

Method clone()

The objects of this class are cloneable with this method.

Usage

S3Input$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

Note: Strong consistency is not guaranteed if S3Prefix is provided here. S3 list operations are not strongly consistent. Use ManifestFile if strong consistency is required.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.